skoupidi 27ed89579d doc/dev/contrib/contrib: use relative paths for links		1 gadu atpakaļ
..
src	27ed89579d doc/dev/contrib/contrib: use relative paths for links	1 gadu atpakaļ
theme	7ada52b28b rename mod_r_p() -> fp_mod_fv(), and mod_p_r_unsafe() -> fv_mod_fp_unsafe()	2 gadi atpakaļ
.gitignore	0eb4049575 doc: use a venv for python deps	1 gadu atpakaļ
Makefile	3e7bc53af0 doc: removed faucetd references	2 gadi atpakaļ
README.md	0eb4049575 doc: use a venv for python deps	1 gadu atpakaļ
book.toml	75c4416711 book: tx lifetime	3 gadi atpakaļ
build_jsonrpc.py	8c33d59f40 chore: updated all repo references to codeberg	2 gadi atpakaļ
generate_seminar_ics.py	ae3c67a7e0 replace ircd with darkirc throughout the codebase	2 gadi atpakaļ
ghp_push.py	310a28f53a book: Always overwrite history to reduce repo size.	3 gadi atpakaļ
latex-macros.txt	fcb1ca1242 book/consensus: add formalisms for block rank calcs	2 gadi atpakaļ
remove_chapter_nav_js.py	1a863ef8d8 doc/book: chmod +x remove_chapter_nav_js.py, to fix github action failing	2 gadi atpakaļ
requirements.txt	0eb4049575 doc: use a venv for python deps	1 gadu atpakaļ

The DarkFi book

This directory contains the sources for the book that can be read on https://darkrenaissance.github.io/darkfi

When adding or removing a section of the book, make sure to update the SUMMARY.md file to actually list the contents.

Use a python virtual environment to install its requirements:

% python -m venv venv
% source venv/bin/activate

Then install the requirements:

% pip install -r requirements.txt

For the mdbook-katex backend run:

cargo install --git "https://github.com/lzanini/mdbook-katex"
cargo install --git "https://github.com/badboy/mdbook-toc"
cargo install --git "https://github.com/badboy/mdbook-mermaid"

README.md

The DarkFi book