Skip to content
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

Jump to bottom

Update install instructions for probe-rs #77

Merged
merged 1 commit into from
May 24, 2024
Merged

Update install instructions for probe-rs #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ If you aren't using a debugger (or want to use other debugging configurations),
rustup target install thumbv6m-none-eabi
cargo install flip-link
# Installs the probe-rs tools, including probe-rs run, our recommended default runner
cargo install probe-rs --features=cli --locked
cargo install --locked probe-rs-tools
# If you want to use elf2uf2-rs instead, do...
cargo install elf2uf2-rs --locked
cargo install --locked elf2uf2-rs
```
If you get the error ``binary `cargo-embed` already exists`` during installation of probe-rs, run `cargo uninstall cargo-embed` to uninstall your older version of cargo-embed before trying again.

Expand Down Expand Up @@ -138,12 +138,12 @@ Some of the options for your `runner` are listed below:
*Step 1* - Install `cargo-embed`. This is part of the [`probe-rs`](https://crates.io/crates/probe-rs) tools:

```console
$ cargo install probe-rs --features=cli --locked
$ cargo install --locked probe-rs-tools
```

*Step 2* - Update settings in [Embed.toml](./Embed.toml)
- The defaults are to flash, reset, and start a defmt logging session
You can find all the settings and their meanings [in the probe-rs repo](https://github.com/probe-rs/probe-rs/blob/c0610e98008cbb34d0dc056fcddff0f2d4f50ad5/probe-rs/src/bin/probe-rs/cmd/cargo_embed/config/default.toml)
You can find all the settings and their meanings [in the probe-rs repo](https://github.com/probe-rs/probe-rs/blob/c435072d0f101ade6fc3fde4a7899b8b5ef69195/probe-rs-tools/src/bin/probe-rs/cmd/cargo_embed/config/default.toml)

*Step 3* - Use the command `cargo embed`, which will compile the code, flash the device
and start running the configuration specified in Embed.toml
Expand All @@ -157,7 +157,7 @@ Some of the options for your `runner` are listed below:

*Step 2* - Install `probe-rs`
```console
$ cargo install probe-rs --features=cli --locked
$ cargo install --locked probe-rs-tools
```

*Step 3* - Open this project in VSCode
Expand Down
Loading