itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-27 12:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix example running commands (#3543)

Browse Source
This commit is contained in:
Simon Fondrie-Teitler 2025-05-23 18:01:14 -04:00 committed by GitHub
parent ff3c5f4bb3
commit a5d7c11c34
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
examples/README.md
View File

@ -12,20 +12,20 @@ As previously stated, we use the [cargo-xtask] pattern for automation. Commands
## Building Examples
You can build all examples for a given device using the `build-examples` subcommand:
You can build all examples for a given device using the `build examples` subcommand:
```shell
cargo xtask build-examples esp-hal esp32
cargo xtask build examples esp-hal esp32
```
Note that we must specify which package to build the examples for, since this repository contains multiple packages.
Note that we must specify which package to build the examples for, since this repository contains multiple packages (specifying esp-hal will build the examples in the examples package instead).
## Running Examples
You can also build and then subsequently flash and run an example using the `run-example` subcommand. With a target device connected to your host system, run:
You can also build and then subsequently flash and run an example using the `run example` subcommand. With a target device connected to your host system, run:
```shell
cargo xtask run-example esp-hal esp32c6 hello_world
cargo xtask run example esp-hal esp32c6 --example embassy_hello_world
```
Again, note that we must specify which package to build the example from, plus which example to build and flash to the target device.