You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: examples/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ For more information regarding the examples, refer to the `README.md` file in an
13
13
You can build all examples for a given device using the `build examples` subcommand:
14
14
15
15
```shell
16
-
cargo xtask build examples esp-hal esp32
16
+
cargo xtask build examples esp-hal --chip esp32 all
17
17
```
18
18
19
19
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
23
23
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:
24
24
25
25
```shell
26
-
cargo xtask run example esp-hal esp32c6 --example embassy_hello_world
26
+
cargo xtask run example embassy_hello_world --chip=esp32c6
27
27
```
28
28
29
29
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