x
90099c3cf3
doc: Document event graph operator recovery
|
hai 1 mes | |
|---|---|---|
| .. | ||
| src | hai 1 mes | |
| theme | hai 6 meses | |
| .gitignore | hai 1 ano | |
| Makefile | hai 7 meses | |
| README.md | hai 7 meses | |
| book.toml | hai 6 meses | |
| build_jsonrpc.py | hai 7 meses | |
| generate_seminar_ics.py | hai 7 meses | |
| ghp_push.py | %!s(int64=3) %!d(string=hai) anos | |
| latex-macros.txt | hai 7 meses | |
| remove_chapter_nav_js.py | hai 7 meses | |
| requirements.txt | hai 1 ano | |
README.md
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