scip/epuppy
1
0
Fork 0
mirror of https://codeberg.org/scip/epuppy.git synced 2025-12-16 03:51:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Thomas von Dein
2025-10-15 21:49:56 +02:00
parent 246dc844f1
commit cf65d9613b
2 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@@ -30,3 +30,9 @@ go.work.sum
# Editor/IDE
# .idea/
# .vscode/
# test files
*.epub
*.txt
epuppy

44
README.md
View File

@@ -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