From 0eb1e5885e94048eb27c15e2a7b75a93e21bc0a5 Mon Sep 17 00:00:00 2001 From: benadha Date: Fri, 29 Oct 2021 23:23:02 +0700 Subject: Implement SeamlessBetweenChapters Squashed commit of the following: commit 3354294302ceae83dcd09bf8c927c9c929bebd55 Author: benadha Date: Fri Oct 29 23:21:16 2021 +0700 Implement SeamlessBetweenChapters feature commit 974f04678441b944db0551e63c0af898f3cedaed Author: benadha Date: Tue Oct 26 22:28:49 2021 +0700 Added seamless adjustment when opening images commit 71cceffaf2177301f6f89e280d50ec80347f1082 Author: benadha Date: Tue Oct 26 22:06:57 2021 +0700 Initial working seamless between content feature commit dcade1e1ac3c8dc5080d474ea5746de43364bc27 Author: benadha Date: Tue Oct 26 20:49:13 2021 +0700 Separate html parsing into its own method parse_html() and remove line for src_lines suffix --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9ecd6d2..ce69b27 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,15 @@ This is just a fork of my own [epr](https://github.com/wustho/epr) with these ex - 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) +- Seamless (disabled by default, read [below](#reading-tips-using-epy)) ## Note on `v2021.10.23` and beyond There happened major refactoring for `epy` in version `v2021.10.23` which harness a lot of new stuffs in python standard libraries starting from `python>=3.7`, so `epy` won't be compatible with older python version and won't be backward compatible -with older `epy` version. And if you decide to install this version you might lose +with older `epy` configuration and reading states. +So if you decide to install this version, you will lose your reading progress with older `epy`. ## Installation @@ -51,15 +53,23 @@ your reading progress with older `epy`. ## Reading Tips Using Epy 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`). +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`). + +If you really want to get seamless reading experience, you can set `SeamlessBetweenChapters` +to `true` in configuration file. But it has its drawback with more memory usage, that's why +it's disabled by default. ## 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` +- Linux: `~/.config/epy/configuration.json` or `~/.epy/configuration.json` +- Windows: `%USERPROFILE%\.epy\configuration.json` Although, there are not many stuffs to configure. -- cgit