mirror of
https://github.com/darkrenaissance/darkfi.git
synced 2026-04-28 03:00:18 -04:00
All port references in the documentation are updated to use the new ports specified in the node config. doc. Changes: - Tor/i2p/Nym ports were updated in sequence +1 (9601, 9602, 9603) - Removed all legacy port references (f.e. 25551, 26661, 5262) Many things were correct already. I want to note, that there might be still some issues, even though this is a commit, I am waiting for a PR until things are clear.
The DarkFi book
This directory contains the sources for the book that can be read on https://dark.fi/book/
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 plugin mdbook backends 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" mdbook-mermaid
cargo install --git "https://github.com/rustforweb/mdbook-plugins" mdbook-tabs