aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index b05e55aa5..c4c01dfbc 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ The <a href="https://docs.embassy.dev/embassy-net/">embassy-net</a> network stac
33 33
34- **Bluetooth** - 34- **Bluetooth** -
35The <a href="https://github.com/embassy-rs/nrf-softdevice">nrf-softdevice</a> crate provides Bluetooth Low Energy 4.x and 5.x support for nRF52 microcontrollers. 35The <a href="https://github.com/embassy-rs/nrf-softdevice">nrf-softdevice</a> crate provides Bluetooth Low Energy 4.x and 5.x support for nRF52 microcontrollers.
36The <a href="https://github.com/embassy-rs/embassy/tree/main/embassy-stm32-wpan">embassy-stm32-wpan</a> crate provides Bluetooth Low Energy 5.x support for stm32wb microcontrollers.
36 37
37- **LoRa** - 38- **LoRa** -
38<a href="https://docs.embassy.dev/embassy-lora/">embassy-lora</a> supports LoRa networking. 39<a href="https://docs.embassy.dev/embassy-lora/">embassy-lora</a> supports LoRa networking.
@@ -111,6 +112,12 @@ cargo install probe-rs --features cli
111cd examples/nrf52840 112cd examples/nrf52840
112``` 113```
113 114
115- Ensure `Cargo.toml` sets the right feature for the name of the chip you are programming.
116 If this name is incorrect, the example may fail to run or immediately crash
117 after being programmed.
118
119- Ensure `.cargo/config.toml` contains the name of the chip you are programming.
120
114- Run the example 121- Run the example
115 122
116For example: 123For example:
@@ -119,6 +126,8 @@ For example:
119cargo run --release --bin blinky 126cargo run --release --bin blinky
120``` 127```
121 128
129For more help getting started, see [Getting Started][1] and [Running the Examples][2].
130
122## Developing Embassy with Rust Analyzer based editors 131## Developing Embassy with Rust Analyzer based editors
123 132
124The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/) 133The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/)
@@ -151,3 +160,5 @@ This work is licensed under either of
151 160
152at your option. 161at your option.
153 162
163[1]: https://github.com/embassy-rs/embassy/wiki/Getting-Started
164[2]: https://github.com/embassy-rs/embassy/wiki/Running-the-Examples