add readme, show help w/o args

This commit is contained in:
2025-10-15 14:43:34 +02:00
parent 7544f8877a
commit b74126b9b0
2 changed files with 30 additions and 0 deletions

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# 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.
## 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

View File

@@ -99,6 +99,9 @@ func InitConfig(output io.Writer) (*Config, error) {
// arg is the epub file
if len(flagset.Args()) > 0 {
conf.Document = flagset.Args()[0]
} else {
flagset.Usage()
os.Exit(1)
}
if conf.Debug {