diff --git a/.gitignore b/.gitignore index aaadf73..59dc811 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,9 @@ go.work.sum # Editor/IDE # .idea/ # .vscode/ + +# test files +*.epub +*.txt + +epuppy diff --git a/README.md b/README.md index 502e646..fe98bc7 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,62 @@ unmaintained but the best I could find to parse EPUBs. Find it in the ![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/darkmode.png) - Viewing an ebook in light mode -![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/lightmode.png) +![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/light.png) - You can interactively adjust text width ![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/margin.png) - Showing the help -![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/darkmode.png) +![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/help.png) ## Installation +The tool does not have any dependencies. Just download the binary for +your platform from the releases page and you're good to go. + +### Installation using a pre-compiled binary + +Go to the [latest release page](https://github.com/TLINDEN/epuppy/releases/latest) +and look for your OS and platform. There are two options to install the binary: + +Directly download the binary for your platform, +e.g. `epuppy-linux-amd64-0.0.2`, rename it to `epuppy` (or whatever +you like more!) and put it into your bin dir (e.g. `$HOME/bin` or as +root to `/usr/local/bin`). + +Be sure to verify the signature of the binary file. For this also +download the matching `epuppy-linux-amd64-0.0.2.sha256` file and: + +```shell +cat epuppy-linux-amd64-0.0.2.sha25 && sha256sum epuppy-linux-amd64-0.0.2 +``` +You should see the same SHA256 hash. + +You may also download a binary tarball for your platform, e.g. +`epuppy-linux-amd64-0.0.2.tar.gz`, unpack and install it. GNU Make is +required for this: + +```shell +tar xvfz epuppy-linux-amd64-0.0.2.tar.gz +cd epuppy-linux-amd64-0.0.2 +sudo make install +``` + ### Installation from source Check out the repository and execute `go build`, then copy the compiled binary to your `$PATH`. +Or, if you have GNU Make installed, just execute: + +```default +make +sudo make install +``` + # Report bugs -[Please open an issue](https://github.com/TLINDEN/gfn/issues). Thanks! +[Please open an issue](https://github.com/TLINDEN/epuppy/issues). Thanks! # License