diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 17 insertions, 3 deletions
@@ -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 ``` |