aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-10-13 20:48:25 +0200
committermetamuffin <metamuffin@disroot.org>2024-10-13 20:48:25 +0200
commit21a9b4087b6612383ee4beb16c2576a4eeb6b38f (patch)
treed296c0ec5dc8569ded563ba46e648b426f4bf9f1 /readme.md
parentc4aebdaddbb4806e98070a833f3608f18fc0a596 (diff)
downloadhurrycurry-21a9b4087b6612383ee4beb16c2576a4eeb6b38f.tar
hurrycurry-21a9b4087b6612383ee4beb16c2576a4eeb6b38f.tar.bz2
hurrycurry-21a9b4087b6612383ee4beb16c2576a4eeb6b38f.tar.zst
integrate book into build system
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index a340dcf1..ff994e61 100644
--- a/readme.md
+++ b/readme.md
@@ -57,6 +57,19 @@ make data server
similar). Running the server in the repository root should work.
- Run the server: `./target/release/hurrycurry-server`
+## Book
+
+### Building
+
+- Requirements:
+ - Python 3
+ - 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 book
+```
+
## Pixel Client
### Building
@@ -93,7 +106,8 @@ make test-client
## Contributing
-For discussion regarding development, feel free to join our matrix room: [#hurrycurry:metamuffin.org](https://matrix.to/#/#hurrycurry:metamuffin.org).
+For discussion regarding development, feel free to join our matrix room:
+[#hurrycurry:metamuffin.org](https://matrix.to/#/#hurrycurry:metamuffin.org).
## License