diff options
| author | ivan <44473782+iamchokerman@users.noreply.github.com> | 2022-03-25 15:32:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-25 21:32:47 +0700 |
| commit | 7c2f28a0ba58d1c2eef0e8bd8aa3ef012a2590f1 (patch) | |
| tree | 2ed842bf7771026b470e95e20a0fffa2947613e1 /README.md | |
| parent | 3ef26d04ad50a884b3c0e6dced32f47375b90939 (diff) | |
| download | epy-7c2f28a0ba58d1c2eef0e8bd8aa3ef012a2590f1.tar.gz | |
docs: define word setup (#55)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 12 insertions, 6 deletions
@@ -16,7 +16,7 @@ This is just a fork of [epr](https://github.com/wustho/epr) with these extra fea - [URL](#url-support) - Reading progress percentage - Bookmarks -- External dictionary integration (`sdcv` or `dict`) +- External dictionary integration (`sdcv`, `dict` or `wkdict`) - 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)) - [Double Spread](#double-spread) @@ -24,22 +24,22 @@ This is just a fork of [epr](https://github.com/wustho/epr) with these extra fea ## Installation -- Via PyPI +- Via PyPI (Linux and Mac OS) ```shell - $ pip3 install epy-reader + pip3 install epy-reader ``` - Via Pip+Git ```shell - $ pip3 install git+https://github.com/wustho/epy + pip3 install git+https://github.com/wustho/epy ``` - Via AUR ```shell - $ yay -S epy-git + yay -S epy-git ``` - Windows Binary @@ -64,7 +64,7 @@ it's disabled by default. Config file is available in json format which is located at: -- Linux: `~/.config/epy/configuration.json` or `~/.epy/configuration.json` +- Linux and Mac OS: `~/.config/epy/configuration.json` or `~/.epy/configuration.json` - Windows: `%USERPROFILE%\.epy\configuration.json` ## URL Support @@ -109,6 +109,12 @@ List of supported engines: - `mimic` - `pico2wave` +## Dictionary + +To use "Define Word" you will have to install an external dictionary cli program (`sdcv`, `dict` or `wkdict`). After you've done that, it is recommended to manually modify the configuration.json file, and set your desired dictionary there, so everything works properly. + +After that you will be able to find definition of word by pressing `d`, and aprompt will appear to let you type in word to define. + ## Double Spread Double spread is intended to mimic the behaviour of real book, |