Highlight how to run examples locally

This commit is contained in:
Henrik Tjäder 2022-01-21 13:28:14 +01:00
parent d51aaf3ad3
commit a34f0205b3
2 changed files with 17 additions and 0 deletions

View file

@ -15,3 +15,18 @@ Check [the embedded Rust book] for instructions on how to set up an
embedded development environment that includes QEMU.
[the embedded Rust book]: https://rust-embedded.github.io/book/intro/install.html
To run the examples found in `examples/` locally, cargo needs a supported `target` and
either `--examples` (run all examples) or `--example NAME` to run a specific example.
Assuming dependencies in place, running:
``` console
$ cargo run --target thumbv7m-none-eabi --example locals
```
Yields this output:
``` console
{{#include ../../../ci/expected/locals.run}}
```

View file

@ -37,6 +37,8 @@ The example application shown below contains two tasks where each task has acces
{{#include ../../../../examples/locals.rs}}
```
Running the example:
``` console
$ cargo run --target thumbv7m-none-eabi --example locals
{{#include ../../../../ci/expected/locals.run}}