diff options
author | Tsu-gu <108401269+Tsu-gu@users.noreply.github.com> | 2022-10-31 05:19:14 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-31 12:19:14 +0700 |
commit | f6965def67103ccd398b198471548fd96c401147 (patch) | |
tree | def15e3d4b3dcd9e4165436d6ff7fa60df7ff568 | |
parent | 6dd186099b868a8f0998f0474663971a4b86324c (diff) | |
download | epy-f6965def67103ccd398b198471548fd96c401147.tar.gz |
A suggestion for enhancing the Readme file (#69)
* Updated the readme
Added descriptions of the commands as well as the color profiles.
* Readme suggestion
The current readme doesn't contain usage instructions for things like changing the colors, so here they are.
* Update README.md
-rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
@@ -46,6 +46,36 @@ This is just a fork of [epr](https://github.com/wustho/epr) with these extra fea Standalone binary for Windows is available at [release page](https://github.com/wustho/epy/releases). +## Usage +- `epy /path/to/your/book/book.epub` (Remember to make sure your book's title doesn't contain any spaces) +- **c** Switching the color profile +- **Shift + h** Previous chapter +- **Shift + l** Next chapter +- **Shift + g** Skip to the end of the chapter +- **g** Skip to the beginning of the chapter +- **Shift + m** Show metadata of the book +- **t** Table of contents +- **/** Search +- **b** Add bookmark +- **Shift + b** Show bookmarks +- **q** Quit +- **-** Shrink the text +- **+** Enlarge the text +- **o** Open an image +- **s** Show or hide progress + +## Color profiles +In the config file you will see the following section. + ``` + "DarkColorFG": 47, + "DarkColorBG": 235, + "LightColorFG": 238, + "LightColorBG": 253, + ``` + +Change the values by using this image. (Make sure to ignore zeros at the beginning, it won't launch otherwise.) +![image](https://user-images.githubusercontent.com/108401269/198876974-c8420de1-b256-42fd-9a09-3a69c5019608.png) + ## Reading Tips Using Epy When reading using `epy` you might occasionally find triple asteriks `***`. |