aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris Guyonvarch2025-12-26 18:41:26 +0100
committerJoris Guyonvarch2025-12-27 20:41:44 +0100
commita110c200e86d2325af07167531fac0f61d9681a0 (patch)
tree90e843f915a2e153ba735849afd83710d90560bf /README.md
parenta26d92ad5055fa057647158eb79511e7b1841162 (diff)
Switch to GUI to manage the library
Allow to regroup the CLI and the view into one unique tool.
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 17 insertions, 33 deletions
diff --git a/README.md b/README.md
index d676bf2..d6c9651 100644
--- a/README.md
+++ b/README.md
@@ -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