Skip to content

Commit dea6813

Browse files
committed
Add apps README and set --manifest-path in CI
Add apps/README.md documenting the standalone application crates, their structure, and how to run them (cargo xtask examples and notes). Update GitHub Actions CI workflow to pass --manifest-path Cargo.toml to cargo fmt and cargo doc so formatting and docs run correctly from the repository root/workspace manifest.
1 parent 0243119 commit dea6813

2 files changed

Lines changed: 51 additions & 2 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
toolchain: stable
4141
components: rustfmt
4242
- name: Check formatting
43-
run: cargo fmt --all -- --check
43+
run: cargo fmt --all --manifest-path Cargo.toml -- --check
4444

4545
clippy:
4646
runs-on: ubuntu-latest
@@ -106,6 +106,6 @@ jobs:
106106
with:
107107
toolchain: stable
108108
- name: Build docs
109-
run: cargo doc --no-deps
109+
run: cargo doc --manifest-path Cargo.toml --no-deps
110110
env:
111111
RUSTDOCFLAGS: -D warnings

‎apps/README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Apps
2+
3+
Standalone application crates for hardware verification and usage examples. These
4+
crates are not published to crates.io.
5+
6+
---
7+
8+
## Table of Contents
9+
10+
- [Overview](#overview)
11+
- [Structure](#structure)
12+
- [Running With `cargo xtask`](#running-with-cargo-xtask)
13+
- [Notes](#notes)
14+
15+
---
16+
17+
## Overview
18+
19+
The `apps/` directory contains crates that exercise the driver on real ESP32
20+
hardware. They are intentionally kept out of the main crate to avoid host
21+
build requirements.
22+
23+
---
24+
25+
## Structure
26+
27+
| Path | Purpose |
28+
|------|---------|
29+
| `apps/examples/` | Example applications (esp-hal, smoltcp, embassy-net) |
30+
| `apps/qa-runner/` | Hardware QA runner for WT32-ETH01 |
31+
32+
---
33+
34+
## Running With `cargo xtask`
35+
36+
Run from the repo root:
37+
38+
```bash
39+
cargo xtask run ex-embassy-net
40+
cargo xtask run ex-smoltcp
41+
cargo xtask run qa-runner
42+
```
43+
44+
---
45+
46+
## Notes
47+
48+
See `apps/examples/README.md` and `apps/qa-runner/README.md` for details and
49+
hardware setup.

0 commit comments

Comments
 (0)