Skip to content

Commit 4df1c54

Browse files
authored
README: emphasize on-target tests
1 parent cb050c9 commit 4df1c54

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

.cargo/config.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,6 @@ unit = "test --features stm32wl5x_cm4,chrono,embedded-time"
3333
unit-little = "test --features stm32wl5x_cm0p,chrono,embedded-time"
3434
unit-nucleo = "test -p nucleo-wl55jc-bsp --features stm32wl5x_cm4"
3535
unit-lora-e5 = "test -p lora-e5-bsp"
36+
37+
[env]
38+
DEFMT_LOG = "trace"

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,19 @@ features = [
4747

4848
## Examples
4949

50-
All examples run on the NUCLEO-WL55JC2. Examples are located in the `examples` crate. The arguments got long for this, so a `run-ex` cargo alias is provided.
50+
All examples run on the NUCLEO-WL55JC2.
51+
52+
Most examples are written in the form of on-target tests. See [testsuite/README.md](https://github.com/stm32-rs/stm32wlxx-hal/blob/main/testsuite/README.md) for details.
53+
54+
There are also simple examples located in the `examples` crate. These can be run with the `run-ex` cargo alias:
5155

5256
```bash
53-
DEFMT_LOG=trace cargo run-ex gpio-blink
57+
cargo run-ex gpio-blink
5458
```
5559

56-
The on-target tests are also excellent reference material.
57-
5860
### System Level Example
5961

60-
The testsuites and examples are a good starting point, but they demonstrate features independent of each-other. A system-level example using multiple features simultaneously is provided in a separate repo: [stm32wl-lightswitch-demo](https://github.com/newAM/stm32wl-lightswitch-demo)
62+
The on-target tests and examples are a good starting point, but they demonstrate features independent of each-other. A system-level example using multiple features simultaneously is provided in a separate repo: [stm32wl-lightswitch-demo](https://github.com/newAM/stm32wl-lightswitch-demo)
6163

6264
## Unit Tests
6365

@@ -67,10 +69,6 @@ Off-target unit tests use the built-in cargo framework. You must specify the tar
6769
cargo test --features stm32wl5x_cm4
6870
```
6971

70-
## On-Target Tests
71-
72-
See [testsuite/README.md](https://github.com/stm32-rs/stm32wlxx-hal/blob/main/testsuite/README.md).
73-
7472
## Reference Documentation
7573

7674
* [stm32wl5x reference manual](https://www.st.com/resource/en/reference_manual/rm0453-stm32wl5x-advanced-armbased-32bit-mcus-with-subghz-radio-solution-stmicroelectronics.pdf)

0 commit comments

Comments
 (0)