From 96c93c61128610def218c9ff3a3541807ea99d17 Mon Sep 17 00:00:00 2001 From: Andrew Dolgov Date: Sun, 9 Apr 2023 15:16:17 +0000 Subject: Update Home --- Home.md | 124 +++++++++++++++++++++++++++++++++------------------------------- 1 file changed, 63 insertions(+), 61 deletions(-) diff --git a/Home.md b/Home.md index e38acea..34d68b1 100644 --- a/Home.md +++ b/Home.md @@ -1,62 +1,64 @@ -## The Epube - -Self-hosted web EPUB reader using EPUB.js, Bootstrap, and Calibre. - -* responsive, offline-capable design; -* integrates with Calibre library; -* multi-device sync of last-read pages (when online); -* word definition lookups using dictd / Wiktionary; -* supports Chrome homescreen "app mode"; -* optional hyphenation using [hyphen](https://github.com/ytiurin/hyphen) library; -* various themes, etc; - -See also: - -* [Android client (wrapper)](https://git.tt-rss.org/fox/the-epube-android) -* [Demo](https://srv.tt-rss.org/books/) (login as demo, demo; database is restored every three hours) - -### Screenshots - - - -### UI cheat sheet - -* Switch pages: Left, Right, Mouse wheel, swipe left/right, space, taps/clicks on left and right sides of the window -* Show UI if it's hidden: escape or tap somewhere in the middle of reader window -* Dictionary lookup: double click/select one word - -### Installation - -I suggest using compose with my [Docker Hub](https://hub.docker.com/u/cthulhoo) images (note `static-dockerhub` [branch](https://git.tt-rss.org/fox/epube-docker-compose.git/tree/?h=static-dockerhub) below). Those go through a proper CI/CD pipeline so there are some safeguards involved which would hopefully prevent a broken image getting pushed out. - -```sh -git clone -b static-dockerhub https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose - -cd epube-docker-compose -cp .env-dist .env -vi .env - -docker-compose up -``` - -Alternatively, you can use [master branch](https://git.tt-rss.org/fox/epube-docker-compose.git/) compose file which would build a DIY image using latest Epube source from Git: - -```sh -git clone https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose - -cd epube-docker-compose -cp .env-dist .env -vi .env - -docker-compose up --build -``` - ---------------- - -For host installation, see [README.md](https://git.tt-rss.org/fox/the-epube.git/tree/README.md) - -### FAQ - -#### Moving between pages is slow with some books - +## The Epube + +Self-hosted web EPUB reader using EPUB.js, Bootstrap, and Calibre. + +* responsive, offline-capable design; +* integrates with Calibre library; +* multi-device sync of last-read pages (when online); +* word definition lookups using dictd / Wiktionary; +* supports Chrome homescreen "app mode"; +* optional hyphenation using [hyphen](https://github.com/ytiurin/hyphen) library; +* various themes, etc; + +See also: + +* [Android client (wrapper)](https://git.tt-rss.org/fox/the-epube-android) +* [Demo](https://srv.tt-rss.org/books/) (login as demo, demo; database is restored every three hours) + +### Screenshots + + + + + +### UI cheat sheet + +* Switch pages: Left, Right, Mouse wheel, swipe left/right, space, taps/clicks on left and right sides of the window +* Show UI if it's hidden: escape or tap somewhere in the middle of reader window +* Dictionary lookup: double click/select one word + +### Installation + +I suggest using compose with my [Docker Hub](https://hub.docker.com/u/cthulhoo) images (note `static-dockerhub` [branch](https://git.tt-rss.org/fox/epube-docker-compose.git/tree/?h=static-dockerhub) below). Those go through a proper CI/CD pipeline so there are some safeguards involved which would hopefully prevent a broken image getting pushed out. + +```sh +git clone -b static-dockerhub https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose + +cd epube-docker-compose +cp .env-dist .env +vi .env + +docker-compose up +``` + +Alternatively, you can use [master branch](https://git.tt-rss.org/fox/epube-docker-compose.git/) compose file which would build a DIY image using latest Epube source from Git: + +```sh +git clone https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose + +cd epube-docker-compose +cp .env-dist .env +vi .env + +docker-compose up --build +``` + +--------------- + +For host installation, see [README.md](https://git.tt-rss.org/fox/the-epube.git/tree/README.md) + +### FAQ + +#### Moving between pages is slow with some books + This happens sometime on slow devices, i.e. phones. The usual reason is Epub chapters are too large. Those can be split into smaller sections with Calibre epub converter: *EPUB Output -> Split files larger than ->* set a smaller value, 100KB should be fine. \ No newline at end of file -- cgit v1.2.3