mirror of
https://github.com/hinto-janai/cuprate.git
synced 2025-04-21 21:28:10 +00:00
550d8598e4
* title * fixes * add `--version` table * add types * config docs * add macro docs * fix * case * Update binaries/cuprated/src/config.rs --------- Co-authored-by: Boog900 <boog900@tutanota.com> |
||
|---|---|---|
| .. | ||
| architecture | ||
| protocol | ||
| user | ||
| README.md | ||
Books
This directory contains the source files for Cuprate's various books.
The source files are edited here, and published in other repositories, see:
Build tools
Building the book(s) requires Rust's cargo tool and mdBook.
After installing cargo, install mdbook with:
cargo install mdbook
Building
To build a book, from the root of Cuprate:
# This build Cuprate's user book.
mdbook build ./books/user
The output will be in the book subdirectory (user/book for the above example). To open the book, you can open it in
your web browser like so:
mdbook build ./books/user --open