Adds a readme #428

Merged
Dandaedre merged 1 commits from ci-end into review 2025-10-19 17:38:37 +02:00
1 changed files with 18 additions and 0 deletions

18
Readme.md Normal file
View File

@ -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)