Skip to main content
Version: 0.1.0

Getting Started

Prerequisites​

  • Rust stable toolchain (rustup + cargo)
  • Git

Build and test​

From the repository root:

cargo check --workspace
cargo test --workspace

Formatting and linting​

cargo fmt --all
cargo clippy --workspace --all-targets

Generate documentation site content​

From noxtls/docs:

npm install
npm run docs:sync
npm run start

docs:sync regenerates:

  • crate API pages under docs/docs/api
  • release notes page from docs/changelog.json

Next steps​