aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-02 13:28:29 +0200
committerDanilo M. <danix@danix.xyz>2026-10-02 13:28:29 +0200
commit402fbef0cd555a8c3288698b0231f22147f57880 (patch)
tree25c6333606110b6499f24849707f36bb5377d7ca /README.md
parentc5a0d1ca39a0ae61e03b0f38a30579b811b4b858 (diff)
downloadbook-reader-master.tar.gz
book-reader-master.zip
Turn the reader into a series library with a bottom status barHEADmaster
LIBRARY is now a folder with one subfolder per series; every image folder inside a series is a book. The library screen shows a grid of series that drills into multi-book series, with search (/) and Esc to go back. Folders are scanned in parallel. Book ids are paths relative to the library, so reading progress survives moving the library. The server links LIBRARY as "library/". The floating HUD becomes a fixed full-width bottom bar: library button and "series / book" on the left, progress in the middle, page numbers and fit/fullscreen on the right. Pages are sized to leave it clear. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5ad3942..cab4bde 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,29 @@ Browser viewer for books stored as folders of page images. Shows two pages
side by side with a 3D page-turn animation, flips with keyboard, mouse wheel
or click, and remembers where you stopped in each book.
-Every folder under the library that contains images is a book, named after
-the folder. Pages are sorted in natural order (`2.jpg` before `10.jpg`).
+The library is one folder with a subfolder per series. Every folder inside a
+series that contains images is a book, named after its folder. Pages are
+sorted in natural order (`2.jpg` before `10.jpg`).
+
+```
+library/
+ Series A/ <- images here: the main book "Series A"
+ Extras/ <- another book of Series A
+ Series B/
+ Vol 1/
+ Vol 2/
+```
+
+The library screen (`b`) shows a grid of series; a series with more than one
+book opens to its books, a single-book series opens straight away. `/`
+searches the current grid, Esc goes back.
## Usage
Create `~/.config/book-reader.conf`:
```sh
-LIBRARY="/path/to/collection"
+LIBRARY="/path/to/library"
PORT=8642
```