From 81f55857c9862c909d3f282d84c758c619e1fa44 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Sun, 19 Oct 2025 17:35:39 +0200 Subject: [PATCH] Adds a readme --- Readme.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..4ad0768 --- /dev/null +++ b/Readme.md @@ -0,0 +1,18 @@ +# The Ravenous Book +All the ressources to compile the ravenous book into a PDF. + +# Continuous integration +A full CI toolchain is set up on [dev-ci](https://books.dandaedre.com/Ravenous_dev/) / [review](https://books.dandaedre.com/Ravenous_review/) / [master](https://books.dandaedre.com/Ravenous/) in order to lower the editing requirements making any push a generation of the book. + +# How to build +## Toolchain +### Core rules editing +* A working latex install (texlive/pdflatex) +### For weapon/class stats editing +* [ravenous-tools](https://proxy.dandaedre.com/gitea/Ravenous/ravenous-tools) (Compiling from source will necessitate a working rust compiler) +* A way to edit a sqlite database +## Building process +* Regenerate the classes/craft `ravenous-tools tablegen all` +* Regenerate the weapons `not yet implemented` +* Regenerate the graphs `ravenous-tools graphs gen` +* Build the pdf `ravenous-tools make` (there are many options to avoid regenerating all the pdf if not needed) -- 2.45.1