The developer documentation contains a comment mentioning the version of Nim that the project is tested against. This comment was not updated for a while (last Nim update in #2508). Bumping now to be in sync once more. |
||
---|---|---|
.. | ||
nbc_audit_2020 | ||
the_auditors_handbook | ||
the_nimbus_book | ||
README.md | ||
attestation_flow.dot | ||
attestation_flow.md | ||
attestation_flow.png | ||
block_flow.dot | ||
block_flow.md | ||
block_flow.png | ||
cpu_features.md | ||
e2store.md | ||
logging.md | ||
rayonism_catalyst_logs.png | ||
rayonism_merge.md | ||
rayonism_metamask_network_setup.png | ||
rayonism_metamask_send_eth.png | ||
rayonism_metamask_transaction_confirmation.png |
README.md
The books in this folder were produced using mdBook - see installation guide.
Some books also use mdbook-toc for tables of contents.
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook mdbook-toc mdbook-open-on-gh
# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_nimbus_book
mdbook serve -p 4000
# Publish book using makefile (in the top-level dir)
make publish-book