aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9130a59081d68b779aa4c40b95b92d7aa8311d8f (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
# Books

Visualize a book library.

## Book library

Organize folders as you wish, only `metadata.json` files matter:

```json
{
  "title": "Title of the Book",
  "subtitle": "Optional subtitle",
  "authors": [ "Author 1", "Author 2" ],
  "authorsSort": "Author sorting",
  "genres": [ "Foo", "Bar", "Baz" ],
  "year": "1234",
  "read": "Read"
}
```

`read` is one of: `Read`, `Unread`, `Reading`, `Stopped`.

Each `metadata.json` file correspond to a book, and there **must** be a cover
named `cover.ext` in the same directory. Any extension works.

## Show library

View the book library by running:

    ./bin/view browser-cmd path-to-books

## Dev server

Enter nix shell:

    nix develop

Then run the dev-server:

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