1.3 KiB
1.3 KiB
Getting started
Prerequisites
Use the repository toolchain, Rust 1.90. The workspace declares the embedded
F7 targets and llvm-tools-preview in rust-toolchain.toml.
For host development, run:
cargo test --workspace --offline
cargo clippy --workspace --all-targets --offline --exclude kaptan-geprc-f722-v2 --exclude kaptan-kakute-f7-mini-v3 -- -D warnings
Bare-metal board packages are not host-test targets. Check them with the target-specific commands in Development and verification.
Repository layout
| Path | Responsibility |
|---|---|
boards/ |
Immutable board declarations and linker layouts. |
platforms/stm32f7/ |
Reviewed F722 RTIC platform and peripheral ownership. |
libs/ |
Typed math, estimation, control, safety, protocol, and driver crates. |
tools/sitl/ |
Host-only closed-loop Gazebo simulation. |
docs/ |
This Markdown documentation site. |
Do not add board-local READMEs. Add a page here instead, then link it from
SUMMARY.md.
Build the documentation website
The manual is an mdBook project. The repository's Nix development shell provides the checked tool version:
nix develop -c make -C docs build
The generated static site is written to target/docs/.