cuprate-hinto-janai/books
Boog900 88551c800c
Books: document p2p protocol (#216)
* add admin message definitions

* add block complete entry

* add protocol messages

* add most flows

* add final flows

* fix typos

* move link to epee

* review fixes
2024-07-18 21:34:56 +01:00
..
architecture books: add skeleton and docs (#141) 2024-05-30 01:19:46 +01:00
protocol Books: document p2p protocol (#216) 2024-07-18 21:34:56 +01:00
user books: add user-book template (#154) 2024-06-07 22:04:27 +01:00
README.md books: move in protocol book (#169) 2024-06-24 01:23:39 +01:00

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