diff options
| author | Rukai <[email protected]> | 2021-06-05 13:31:44 +1000 |
|---|---|---|
| committer | Rukai <[email protected]> | 2021-06-05 13:34:44 +1000 |
| commit | f7bef60c8a506c4397b8cfaf52b7bbbf0af5a66c (patch) | |
| tree | 5fbdd9ecdf00986203372c7e0c8e35b325f370d5 | |
| parent | 6f5c85c50f20fa336d2144c8161aea391bea52f7 (diff) | |
Improve examples section of readme
| -rw-r--r-- | README.md | 18 |
1 files changed, 14 insertions, 4 deletions
| @@ -37,11 +37,21 @@ The `embassy-nrf` crate contains implementations for nRF 52 series SoCs. | |||
| 37 | - `gpiote`: GPIOTE driver. Allows `await`ing GPIO pin changes. Great for reading buttons or receiving interrupts from external chips. | 37 | - `gpiote`: GPIOTE driver. Allows `await`ing GPIO pin changes. Great for reading buttons or receiving interrupts from external chips. |
| 38 | - `rtc`: RTC driver implementing `Clock` and `Alarm`, for use with `embassy::executor`. | 38 | - `rtc`: RTC driver implementing `Clock` and `Alarm`, for use with `embassy::executor`. |
| 39 | 39 | ||
| 40 | ## Running the examples | 40 | ## Examples |
| 41 | 41 | ||
| 42 | Examples are for the nRF52840 chip but should be easily adaptable to other nRF52 chips. | 42 | Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on: |
| 43 | * `examples/nrf` are designed to run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards. | ||
| 44 | * `examples/rp` are for the RP2040 chip. | ||
| 45 | * `examples/stm32` are designed for the STM32F429ZI chip but should be easily adaptable to other STM32F4xx chips. | ||
| 46 | * `examples/std` are designed to run locally on your pc. | ||
| 43 | 47 | ||
| 44 | GPIO pins are set up for the `nrf52840-dk` board (PCA10056) | 48 | ### Running examples |
| 49 | |||
| 50 | - Setup git submodules (needed for STM32 examples) | ||
| 51 | ``` | ||
| 52 | git submodule init | ||
| 53 | git submodule update | ||
| 54 | ``` | ||
| 45 | 55 | ||
| 46 | - Install `probe-run` with defmt support. | 56 | - Install `probe-run` with defmt support. |
| 47 | 57 | ||
| @@ -57,7 +67,7 @@ cargo run --bin rtc_async | |||
| 57 | 67 | ||
| 58 | ## Minimum supported Rust version (MSRV) | 68 | ## Minimum supported Rust version (MSRV) |
| 59 | 69 | ||
| 60 | Only recent nighly supported. Nightly is required for: | 70 | Required nightly version is specified in the `rust-toolchain.toml` file. Nightly is required for: |
| 61 | 71 | ||
| 62 | - `generic_associated_types`: for trait funcs returning futures. | 72 | - `generic_associated_types`: for trait funcs returning futures. |
| 63 | - `type_alias_impl_trait`: for trait funcs returning futures implemented with `async{}` blocks, and for `static-executor`. | 73 | - `type_alias_impl_trait`: for trait funcs returning futures implemented with `async{}` blocks, and for `static-executor`. |
