cuprate/books
SyntheticBird b6c4adc83a
Some checks failed
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
Architecture mdBook / build (push) Has been cancelled
Audit / audit (push) Has been cancelled
CI / fmt (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
p2p: Implement P2P Bucket data structure (#329)
Implements P2P Bucket data structure

This commit implements a "Bucket" data structure that is a collection
of data that discriminates its items into "buckets" (vector of size N)
following a defined function.

- Implements Bucket data structure and Bucketable trait
- Implements Bucketable for Ipv4Addr
- Added the crate to the workspace dependencies
- Added arrayvec as a dependency
2024-11-02 00:45:56 +00:00
..
architecture p2p: Implement P2P Bucket data structure (#329) 2024-11-02 00:45:56 +00:00
protocol books: change some definitions (#251) 2024-08-09 00:56:41 +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