cuprate-hinto-janai/books/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:

• Cuprate's architecture book
• Cuprate's protocol book
• Cuprate's user book

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