summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Lilleengen <lulf@redhat.com>2022-06-15 10:44:15 +0200
committerUlf Lilleengen <lulf@redhat.com>2022-06-15 10:44:15 +0200
commiteb237337671af5c9be7fc120e5d5235039dc5e5a (patch)
tree32818ec3a94dab4f77fbd06dee561bfaf5ffe9cf
parent72eb16b46dc9ff12ae38b9d9fb94e3ad7a4b2e65 (diff)
downloadembassy-eb237337671af5c9be7fc120e5d5235039dc5e5a.zip
Ignore compiling rust code
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index eab74bd5..a7a7ccd5 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ The <a href="https://github.com/embassy-rs/nrf-softdevice">nrf-softdevice</a> cr
## Sneak peek
-```rust
+```rust,ignore
use defmt::info;
use embassy::executor::Spawner;
use embassy::time::{Duration, Timer};
@@ -93,20 +93,21 @@ Examples are found in the `examples/` folder seperated by the chip manufacturer
### Running examples
- Setup git submodules (needed for STM32 examples)
-```
+
+```bash
git submodule init
git submodule update
```
- Install `probe-run` with defmt support.
-```
+```bash
cargo install probe-run
```
- Change directory to the sample's base directory. For example:
-```
+```bash
cd examples/nrf
```
@@ -114,7 +115,7 @@ cd examples/nrf
For example:
-```
+```bash
cargo run --bin blinky
```