diff --git a/Cargo.toml b/Cargo.toml index 4738659..67fa538 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -57,7 +57,7 @@ overflow-checks = false # <- # uncomment this to switch from the crates.io version of defmt to its git version # check app-template's README for instructions # [patch.crates-io] -# defmt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" } -# defmt-rtt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" } -# defmt-test = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" } -# panic-probe = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" } +# defmt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" } +# defmt-rtt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" } +# defmt-test = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" } +# panic-probe = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" } diff --git a/README.md b/README.md index ba7df73..2cd2db1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # `app-template` -> Quickly set up a [`probe-run`] + [`defmt`] + [`flip-link`] embedded project +> Quickly set up a [`probe-rs`] + [`defmt`] + [`flip-link`] embedded project > running on the [`RTIC`] scheduler -[`probe-run`]: https://crates.io/crates/probe-run +[`probe-rs`]: https://crates.io/crates/probe-rs [`defmt`]: https://github.com/knurling-rs/defmt [`flip-link`]: https://github.com/knurling-rs/flip-link [`RTIC`]: https://rtic.rs/ @@ -18,11 +18,10 @@ Based on https://github.com/knurling-rs/app-template $ cargo install flip-link ``` -#### 2. `probe-run`: +#### 2. `probe-rs`: ``` console -$ # make sure to install v0.2.0 or later -$ cargo install probe-run +$ cargo install probe-rs --features cli ``` ## Setup @@ -37,9 +36,9 @@ If you look into your new `test-app` folder, you'll find that there are a few `T Let's walk through them together now. -#### 2. Set `probe-run` chip +#### 2. Set `probe-rs` chip -Pick a chip from `probe-run --list-chips` and enter it into `.cargo/config.toml`. +Pick a chip from `probe-rs chip list` and enter it into `.cargo/config.toml`. If, for example, you have a nRF52840 Development Kit from one of [our workshops], replace `$CHIP` with `nRF52840_xxAA`. @@ -48,8 +47,8 @@ If, for example, you have a nRF52840 Development Kit from one of [our workshops] ```diff # .cargo/config.toml [target.'cfg(all(target_arch = "arm", target_os = "none"))'] --runner = "probe-run --chip $CHIP" -+runner = "probe-run --chip nRF52840_xxAA" +-runner = "probe-rs run --chip $CHIP" ++runner = "probe-rs run --chip nRF52840_xxAA" ``` #### 3. Adjust the compilation target diff --git a/src/lib.rs b/src/lib.rs index 1ee2910..3ac29a5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -24,7 +24,7 @@ defmt::timestamp!("{=usize}", { n }); -/// Terminates the application and makes `probe-run` exit with exit-code = 0 +/// Terminates the application and makes `probe-rs` exit with exit-code = 0 pub fn exit() -> ! { loop { cortex_m::asm::bkpt();