aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d676bf21b1bb7e839b7166e36bf60ca89a509639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Books

Visualize a book library.

## Book library

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"
```

`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:

    ./bin/dev-server path-to-books

## Show library

    make
    BOOKS_LIBRARY=path-to-books BOOKS_BROWSER=firefox python src/main.py library

## Add book

    BOOKS_LIBRARY=path-to-books python src/main.py new optional-path-to-ebook