cuprate-hinto-janai/books
hinto-janai 88605b081f
books/architecture: port database design document ()
* add chapters

* add files, intro

* db abstraction

* backends

* abstraction

* syncing

* serde

* issues

* common/types

* common/ops

* common/service

* service diagram

* service/resize

* service/thread-model

* service/shutdown

* storage/blockchain

* update md files

* cleanup

* fixes

* update for https://github.com/Cuprate/cuprate/pull/290

* review fix
2024-09-24 17:23:22 +01:00
..
architecture books/architecture: port database design document () 2024-09-24 17:23:22 +01:00
protocol books: change some definitions () 2024-08-09 00:56:41 +01:00
user books: add user-book template () 2024-06-07 22:04:27 +01:00
README.md books: move in protocol book () 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