diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 17 insertions, 33 deletions
@@ -1,41 +1,25 @@ -# Books +Manage a book library. -Visualize a book library. +- Group by progress +- Associate any number of ebooks to each book +- Transfer individual books to ereader -## Book library +# Running -Organize folders as you wish, only `metadata.toml` files matter: - -```toml -title = "Title of the Book" -subtitle = "Optional subtitle" -authors = [ "Author 1", "Author 2" ] -authorsSort = "Author sorting" -genres = [ "Foo", "Bar", "Baz" ] -year = 1234 -summarry = """ -First paragraph -Second paragraph -""" -read = "Read" +```sh +nix develop --command books ``` -`read` is one of: `Read`, `Unread`, `Reading`, `Stopped`. - -Each `metadata.toml` file correspond to a book, and there **must** be a cover -named `cover.ext` in the same directory. Any extension works. - -## Dev server - -In nix shell (`nix develop`), run: +# Testing - ./bin/dev-server path-to-books - -## Show library - - make - BOOKS_LIBRARY=path-to-books BOOKS_BROWSER=firefox python src/main.py library +```sh +pytest +``` -## Add book +# Improvements - BOOKS_LIBRARY=path-to-books python src/main.py new optional-path-to-ebook +- book flow: keep header bar visible when scrolling down +- filters: + - textual search + https://stackoverflow.com/questions/55828169/how-to-filter-gtk-flowbox-children-with-gtk-entrysearch + - select by genre |