mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-12-22 11:39:30 +00:00
fafa20c20f
* books: add `rpc` skeleton * json-rpc * types section * differences * interface * typos * differences: add `json-formatting.md` * rpc: small fixes * appendix: add `cuprate-rpc-handler` to crate list * differences: remove extra fields section, add more info * differences: add `id:0` section |
||
|---|---|---|
| .. | ||
| 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, 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