mirror of
https://github.com/MAGICGrants/cuprate-for-explorer.git
synced 2026-01-09 19:47:59 -05: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>
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