mirror of
https://github.com/hinto-janai/cuprate.git
synced 2025-01-21 18:24:31 +00:00
4f14452c77
Some checks failed
Architecture mdBook / build (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / wasm-32-bit-support (cuprate-epee-encoding) (push) Has been cancelled
CI / wasm-32-bit-support (cuprate-fixed-bytes) (push) Has been cancelled
CI / wasm-32-bit-support (cuprate-rpc-types) (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
Deny / audit (push) Has been cancelled
Doc / build (push) Has been cancelled
Doc / deploy (push) Has been cancelled
* rm -rf benches * update architecture book * lint fix |
||
|---|---|---|
| .. | ||
| 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