From 7110177e6745ef7483396562a2cc00ca4b1164b2 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Thu, 20 Aug 2026 02:56:13 +0200 Subject: [PATCH] Adds a readme --- Readme.md | 43 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 2f702c8..229f0e4 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,39 @@ -# The Ravenous Book -All the ressources to compile the ravenous book into a PDF. +# Ravenous -# TODO -- [ ] Add a functionnal CI -- [ ] Add a sensible toolchain +Ravenous is a French-language tabletop role-playing game about Hunters: mortals marked by the blood of Calamities who stand between humanity and monstrous threats. This repository contains the Typst sources and assets used to produce its rulebook. + +## Build the book + +Install [Typst](https://typst.app/docs/reference/), clone the repository with its submodules, then compile the main document: + +```sh +git clone --recurse-submodules +cd ravenous_typst +typst compile main.typ main.pdf +``` + +For live rebuilding while editing, use: + +```sh +typst watch main.typ main.pdf +``` + +The CI build also generates Git metadata before compiling. To reproduce that locally: + +```sh +./tools/pseudo_toolchain.sh +typst compile main.typ main.pdf +``` + +## Project layout + +- `main.typ` is the rulebook entry point. +- `chapters/` contains the book's content. +- `setup/` contains shared styles, models, and macros. +- `images/` and `data/` contain supporting assets and game data. + +## Contributing and conduct + +Contributions, corrections, and suggestions are welcome. Keep changes focused, make sure the book still compiles, and explain non-obvious decisions in your pull request or commit message. + +Be respectful and constructive. Harassment, discrimination, personal attacks, and other hostile behaviour are not acceptable in project discussions or contributions.