aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbenadha <benawiadha@gmail.com>2021-01-31 09:06:09 +0700
committerbenadha <benawiadha@gmail.com>2021-01-31 09:06:09 +0700
commit0db0953ce23ddc0b076a9748e7b9095634d69a31 (patch)
tree35e2608a82d2b7e26c9fd4f767063ba46ea85f9a /README.md
parente147f1680785c6588fcdd98ee74042e2fe29604b (diff)
downloadepy-0db0953ce23ddc0b076a9748e7b9095634d69a31.tar.gz
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 71806cc..9c3ee22 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ This is just a fork of my own [epr](https://github.com/wustho/epr) with these ex
- Bookmarks
- External dictionary integration
- 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))
# Installation
@@ -47,3 +48,23 @@ This might be disorienting, so the best way to get seamless reading experience i
| `Scroll Down` | scroll down |
| `Ctrl` + `Scroll Up` | increase text width |
| `Ctrl` + `Scroll Down` | decrease text width |
+
+# Text-to-Speech
+
+To get Text-to-Speech (TTS) support, you need to install these external dependencies:
+
+- `pico2wave` (from `libttspico-utils` package (Ubuntu) or `svox-pico-bin` package (AUR))
+- `play` (from `sox` package)
+
+eg.
+
+```shell
+$ # Ubuntu
+$ apt install libttspico-utils sox
+
+$ # Arch
+$ yay -S svox-pico-bin
+$ pacman -S sox
+```
+
+And then make sure `pico2wave` and `play` is in `$PATH`. \ No newline at end of file