diff options
| author | metamuffin <metamuffin@disroot.org> | 2025-07-13 16:44:00 +0200 |
|---|---|---|
| committer | metamuffin <metamuffin@disroot.org> | 2025-07-13 21:14:21 +0200 |
| commit | 10ef9cc31c82ada3625eab232d8c4b81a1356f1a (patch) | |
| tree | f341e595d20dc02b52a7a9d2cf661acfdedff31f /book/README.md | |
| parent | 8c009e07a3b40b44cc03d54a189de2df76118a53 (diff) | |
| download | hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.bz2 hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.zst | |
Split off component-specific content into seperate readme files
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` |