Skip to content

docs: Fix broken "run examples" commands #971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
9names merged 2 commits into from
Nov 25, 2025
Merged

docs: Fix broken "run examples" commands #971

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63b2d98
docs: Fix broken "run examples" commands
DeflateAwning Nov 16, 2025
d7358f3
docs: Remove obsolete feature flags note in README
DeflateAwning Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,11 +260,12 @@ specified 'runner'. As the 'runner' is picotool, it will flash your compiled
binary over USB.

```sh
cargo run --release --features "critical-section-impl,rt,defmt" --example pwm_blink
cd rp2040-hal-examples # Or: cd rp235x-hal-examples
cargo run --release --bin pwm_blink
```

(The `pwm_blink` example doesn't need all these feature flags. They are listed here
so you can use the same command for all examples.)
Note that some examples require additional feature flags enabled:
e.g., `--features "critical-section-impl,rt,defmt"`.

If you want to create a UF2 file, which is loaded by copying it over to the
RPI-RP2 mass storage device, use the `picotool uf2 convert` command on your
Expand Down Expand Up @@ -322,7 +323,8 @@ RP2040 via the first probe it finds, and install your firmware into the Flash
connected to the RP2040.

```sh
cargo run --release --example pwm_blink
cd rp2040-hal-examples # Or: cd rp235x-hal-examples
cargo run --release --bin pwm_blink
```
[RP2040 Project Template]: https://github.com/rp-rs/rp2040-project-template
[RP235x Project Template]: https://github.com/rp-rs/rp235x-project-template
Expand Down