Getting Started

This guide covers developer setup on a host machine. When you move to device firmware, follow Porting Guide, Configuration Guide, and Memory Usage in addition to the build steps below.

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

Device-oriented next steps

• Porting Guide — checklist for MCU / RTOS integration.
• Embedded targets and I/O — no_std, alloc, transport adapters.
• TLS component — where handshake and record logic live.
• Applications — firmware and gateway patterns.

Reference

• Architecture
• Security
• Crypto API overview