summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRukai <rubickent@gmail.com>2021-06-05 13:31:44 +1000
committerRukai <rubickent@gmail.com>2021-06-05 13:34:44 +1000
commitf7bef60c8a506c4397b8cfaf52b7bbbf0af5a66c (patch)
tree5fbdd9ecdf00986203372c7e0c8e35b325f370d5 /README.md
parent6f5c85c50f20fa336d2144c8161aea391bea52f7 (diff)
downloadembassy-f7bef60c8a506c4397b8cfaf52b7bbbf0af5a66c.zip
Improve examples section of readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 03732306..8d5fddd0 100644
--- a/README.md
+++ b/README.md
@@ -37,11 +37,21 @@ The `embassy-nrf` crate contains implementations for nRF 52 series SoCs.
- `gpiote`: GPIOTE driver. Allows `await`ing GPIO pin changes. Great for reading buttons or receiving interrupts from external chips.
- `rtc`: RTC driver implementing `Clock` and `Alarm`, for use with `embassy::executor`.
-## Running the examples
+## Examples
-Examples are for the nRF52840 chip but should be easily adaptable to other nRF52 chips.
+Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on:
+* `examples/nrf` are designed to run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards.
+* `examples/rp` are for the RP2040 chip.
+* `examples/stm32` are designed for the STM32F429ZI chip but should be easily adaptable to other STM32F4xx chips.
+* `examples/std` are designed to run locally on your pc.
-GPIO pins are set up for the `nrf52840-dk` board (PCA10056)
+### Running examples
+
+- Setup git submodules (needed for STM32 examples)
+```
+git submodule init
+git submodule update
+```
- Install `probe-run` with defmt support.
@@ -57,7 +67,7 @@ cargo run --bin rtc_async
## Minimum supported Rust version (MSRV)
-Only recent nighly supported. Nightly is required for:
+Required nightly version is specified in the `rust-toolchain.toml` file. Nightly is required for:
- `generic_associated_types`: for trait funcs returning futures.
- `type_alias_impl_trait`: for trait funcs returning futures implemented with `async{}` blocks, and for `static-executor`.