The Tari protocol
Documentation
- RFC documents are hosted on Github Pages. The source markdown is in the
RFCdirectory. - Source code documentation is hosted on docs.rs
Serving the documentation locally
RFC documents
Firstly, install mdbook. Assuming you have Rust and cargo installed, run
cargo install mdbook
Then, from the RFC directory, run
mdbook serve
and the RFC documentation will be available at http://localhost:3000.
Source code documentation
Run
cargo doc
to generate the documentation. The generated html sits in target/doc/. Alternatively, to open a specific package's documentation directly in your browser, run
cargo doc -p <package> --open
Code organisation
See RFC-0110/CodeStructure for details on the code structure and layout.
Git submodules
Git submodules are use temporarily until some dependent libraries are stabilized and released as crates.
When checking out code take the following steps to ensure submodules are up to date.
# Initialize submodules
git submodule init
# Sets `git pull` to automatically pull submodules
git config submodule.recurse true
# Checkout/update all submodules
git submodule update --recursive --remote
Conversation channels
Non-technical discussions and gentle sparring.
Forum-style Q&A
and other Tari-related discussions.
Follow @tari to be
the first to know about important updates and announcements about the project.
Most of the technical conversation about Tari development happens on #FreeNode IRC in the #tari-dev room.