Skip to content

Commit 6aaf12a

Browse files
authored
examples/README.md: clarify xtask subcommand usage and arguments (#4067)
- Update example commands to use the new `--chip` argument format for `build examples` and `run example` subcommands. - Improve clarity by showing explicit argument order and usage. - Reflect recent changes in xtask interface for building and running examples. Signed-off-by: Alexei Pastuchov <[email protected]>
1 parent 7248d3d commit 6aaf12a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For more information regarding the examples, refer to the `README.md` file in an
1313
You can build all examples for a given device using the `build examples` subcommand:
1414

1515
```shell
16-
cargo xtask build examples esp-hal esp32
16+
cargo xtask build examples esp-hal --chip esp32 all
1717
```
1818

1919
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/` directory instead.
@@ -23,7 +23,7 @@ Note that we must specify which package to build the examples for, since this re
2323
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:
2424

2525
```shell
26-
cargo xtask run example esp-hal esp32c6 --example embassy_hello_world
26+
cargo xtask run example embassy_hello_world --chip=esp32c6
2727
```
2828

2929
Again, note that we must specify which package to build the example from, plus which example to build and flash to the target device.

0 commit comments

Comments
 (0)