Files
cuprate-for-explorer/books
jermanuts e84f5c151f Readme and user book: Fix links (#406)
* User book: https link to CCS

* Readme: fix contribution and security link

* rust link https
2025-03-13 22:11:04 +00:00
..
2025-03-04 21:36:27 +00:00
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