mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-12-22 11:39:30 +00:00
d21160868c
* update `books/` * update CONTRIBUTING.md * .gitignore: ignore built books * add dummy `books/architecture/` * remove some changes from CONTRIBUTING.md out of scope, will be in another PR * add docs/books to LICENSE * formatting |
||
|---|---|---|
| .. | ||
| architecture | ||
| protocol | ||
| 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, go into a book's directory and build:
# This build Cuprate's architecture book.
cd architecture/
mdbook build
The output will be in the book subdirectory (architecture/book for the above example). To open the book, you can open it in your web browser like so:
mdbook build --open