nimbus-eth2/docs
Johann Bauer c01357c47f
Book: Add instructions on how to download precompiled release (#2600)
2021-05-26 10:43:06 +02:00
..
nbc_audit_2020 Consensus object pools [reorg 4/5] (#2374) 2021-03-04 10:13:44 +01:00
the_auditors_handbook
the_nimbus_book Book: Add instructions on how to download precompiled release (#2600) 2021-05-26 10:43:06 +02:00
README.md
attestation_flow.dot
attestation_flow.md
attestation_flow.png
block_flow.dot
block_flow.md
block_flow.png
cpu_features.md Cpu architecture optimization documentation (#2483) 2021-04-08 15:48:43 +02:00
e2store.md e2store: add era format (#2382) 2021-03-15 11:31:39 +01:00
logging.md
rayonism_catalyst_logs.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_merge.md non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_network_setup.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_send_eth.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_transaction_confirmation.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00

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 top-level)
make publish-book