diff options
Diffstat (limited to 'book/README.md')
| -rw-r--r-- | book/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/book/README.md b/book/README.md new file mode 100644 index 00000000..3fe94365 --- /dev/null +++ b/book/README.md @@ -0,0 +1,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` |