mirror of
https://github.com/Cuprate/cuprate.git
synced 2024-12-22 19:49:28 +00:00
Boog900
519d871ccb
* add protocol bool * update url * fix typos * Cuprate's protocol book -> Monero * Apply suggestions from code review Co-authored-by: hinto-janai <hinto.janai@protonmail.com> * fix typo * POW -> PoW * revert weird line changes --------- Co-authored-by: hinto-janai <hinto.janai@protonmail.com>
952 B
952 B
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, go into a book's directory and build:
# This build Cuprate's user book.
cd user/
mdbook build
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 --open