aboutsummaryrefslogtreecommitdiff
path: root/book/README.md
blob: 3fe943657af49eb3bba7d64f1a9a2d3446c49485 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Hurry Curry! Recipe Book

The recipe book for learning about ingame recipes.

The books layout and content template is defined in `book.js`. It generates a
JSON file containing a simple DOM-like description of the book. This JSON file
can be rendered to PDF with `book.typ` or displayed by the game client.

## Building

- Requirements:
  - GNU make
  - Deno (or Node.js in which case you need to pass `JSR=node` to make)
  - Typst (only if PDF or image export is required)

- Make sure the book-assets submodule is checked out.
- Run `make`