skoupidi 965870ab9b darkfid: support both normal address and base64 encoded mining configurations as miners recipient		7 miesięcy temu
..
src	965870ab9b darkfid: support both normal address and base64 encoded mining configurations as miners recipient	7 miesięcy temu
theme	bf419a6b55 doc: add support for colorizing zkas code samples in darkfi book	1 rok temu
.gitignore	0eb4049575 doc: use a venv for python deps	1 rok temu
Makefile	0d455a405a darkfid: Move misc RPC methods to separate module.	7 miesięcy temu
README.md	dfe77e9c62 doc: mention mdbook in installation instructions	1 rok temu
book.toml	ee68360232 doc: Fix mdbook build with latest mdbook version	7 miesięcy temu
build_jsonrpc.py	d56580bd9e doc: Fix RPC source links to be proper with proper anchors	7 miesięcy temu
generate_seminar_ics.py	ae3c67a7e0 replace ircd with darkirc throughout the codebase	2 lat temu
ghp_push.py	310a28f53a book: Always overwrite history to reduce repo size.	3 lat temu
latex-macros.txt	ee68360232 doc: Fix mdbook build with latest mdbook version	7 miesięcy temu
remove_chapter_nav_js.py	68d76dece7 doc: glob chapter nav removal since mdbook now appends a ref	7 miesięcy temu
requirements.txt	0eb4049575 doc: use a venv for python deps	1 rok temu

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

Using the Makefile to build the sources requires the Rust mdbook utility which may be installed via:

cargo install mdbook

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