summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDario Nieuwenhuis <dirbaio@dirbaio.net>2020-09-15 01:08:51 +0200
committerDario Nieuwenhuis <dirbaio@dirbaio.net>2020-09-15 01:08:51 +0200
commit064aaf7fbbcc15a80a5b9a39c6e8eeb981f1af77 (patch)
tree788dfe3e11b41e22407d776864b01fde74ef6e22 /README.md
parentd810e7bf93cca08d8b92d608f5535e3e1abc52bf (diff)
downloadnrf-softdevice-064aaf7fbbcc15a80a5b9a39c6e8eeb981f1af77.zip
Update README with running instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4eef0c1..eee1ab9 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,20 @@ The following nRF chips are supported
Some softdevices support only some chips, check Nordic's documentation for details.
+## Running examples
+
+Instructions for S140 and nrf52840-dk. You may have to adjust accordingly.
+
+Flashing the softdevice is required. It is NOT part of the built binary. You only need to do it once at the beginning, or after doing full chip erases.
+
+- Download SoftDevice S140 from Nordic's website [here](https://www.nordicsemi.com/Software-and-tools/Software/S140/Download). Supported versions are 7.x.x
+- Unzip
+- `nrfjprog --family NRF52 --chiperase --verify --program s140_nrf52_7.0.1_softdevice.hex`
+
+To run an example, simply use `cargo run`:
+
+- `cargo run --bin ble_bas_peripheral`
+
## Low-level raw bindings
The `nrf-softdevice-s1xx` crates contain low-level bindings, matching 1-1 with the softdevice C headers.