Onur Özkan
3226ef97fe
Remove the retired simulator workspace member, dependencies, workflow and documentation. Keep the shared flight and hardware crates. Validation: retirement prefix host check, command-dispatch tests and book build.
28 lines
1010 B
Markdown
28 lines
1010 B
Markdown
# Firmware
|
|
|
|
This directory is the Kaptan flight-controller firmware workspace. It owns the
|
|
Rust workspace manifest, board declarations, platform implementation, reusable
|
|
firmware crates and firmware scripts.
|
|
|
|
```text
|
|
firmware/
|
|
├── boards/ immutable board declarations and linker layouts
|
|
├── libs/ reusable no_std firmware crates
|
|
├── platforms/ hardware platform composition
|
|
├── tools/ firmware development tooling
|
|
└── scripts/ packaging, analysis, and coverage helpers
|
|
```
|
|
|
|
This workspace owns its Makefile. From this directory, list its commands with:
|
|
|
|
```sh
|
|
make help
|
|
```
|
|
|
|
From the repository root, the firmware path is a direct Cargo proxy. For
|
|
example, `make firmware -- test --workspace --locked --offline` runs the host
|
|
test suite. Build and package every supported board with
|
|
`make firmware/boards`, or select one board by its directory path.
|
|
Run `make firmware clippy` for Rust lints and `make firmware docs` for API
|
|
documentation with warnings denied.
|