aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbenadha <benawiadha@gmail.com>2021-02-01 22:23:19 +0700
committerbenadha <benawiadha@gmail.com>2021-02-01 22:23:19 +0700
commit8efaa9cf07a28f84d14478ab1415c2699f5c3af4 (patch)
tree351d42490274ee0673590a75834f596259252050 /README.md
parentb994d74912f3f236497ed6f59b41f2423ec091d8 (diff)
downloadepy-8efaa9cf07a28f84d14478ab1415c2699f5c3af4.tar.gz
- Unused var: LINEPRSRV
- Bug: "" -> r"" - Bug: pgup animation issue - Feature: TTS Speed (tempo) config - Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9c3ee22..2490afe 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ This is just a fork of my own [epr](https://github.com/wustho/epr) with these ex
- AZW3 (.azw3), some but not all (see [KindleUnpack](https://github.com/kevinhendricks/KindleUnpack))
- Reading progress percentage
- Bookmarks
-- External dictionary integration
+- External dictionary integration (`sdcv` or `dict`)
- Inline formats: **bold** and _italic_ (depend on terminal and font capability. Italic only supported in python>=3.7)
- Text-to-Speech (with additional setup, read [below](#text-to-speech))
@@ -37,8 +37,19 @@ When reading using `epy` you might occasionally find triple asteriks `***`.
That means you reach the end of some section in your ebook and the next line (right after those three asteriks, which is in new section) will start at the top of the page.
This might be disorienting, so the best way to get seamless reading experience is by using next-page control (`space`, `l` or `Right`) instead of next-line control (`j` or `Down`).
+# Configuration File
+
+Config file is available in json format which is located at:
+
+- Linux: `~/.config/epy/config.json` or `~/.epy/config.json`
+- Windows: `%USERPROFILE%\.epy\config.json`
+
+Although, there are not many stuffs to configure.
+
# Using Mouse
+Pretty useful when running `epy` on Termux Android.
+
| Key | Action |
| --- | --- |
| `Left Click` (right side of screen) | next page |