# epuppy - terminal epub reader

This is a little TUI epub ebook reader. This is a work in progress and
may not work for all EPUB files yet. It uses a modified version of the
[epub module](https://github.com/kapmahc/epub/), which seems to be
unmaintained but the best I could find to parse EPUBs. Find it in the
`pkg/epub/` directory.

## Screenshots

- Viewing an ebook in dark mode
![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)

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

## Installation

### Installation from source

Check out the repository and execute `go build`, then copy the
compiled binary to your `$PATH`.

# Report bugs

[Please open an issue](https://github.com/TLINDEN/gfn/issues). Thanks!

# License

This work is licensed under the terms of the General Public Licens
version 3.

# Author

Copyleft (c) 2024 Thomas von Dein