summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhuntc <huntchr@gmail.com>2020-12-26 14:01:31 +1100
committerhuntc <huntchr@gmail.com>2020-12-26 14:01:31 +1100
commit3a668d2280dbf3134a5588909b887a0594ece96d (patch)
tree23caf82623e4a90f1681aa5e5cb2f8d1981985d5 /README.md
parent41f00393ddd5607c415ecc3d1862703c85411820 (diff)
downloadnrf-softdevice-3a668d2280dbf3134a5588909b887a0594ece96d.zip
Smooth the getting started
Some changes to the README given guidance. Also, a benign addition to the VS Code settings to stop CMake from being annoying in the case where it is installed.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1cebd0c..89340bf 100644
--- a/README.md
+++ b/README.md
@@ -41,9 +41,24 @@ The following nRF chips are supported
Some softdevices support only some chips, check Nordic's documentation for details.
+## Setting up your build environment
+
+This project uses new toolchain features, often only to be found in nightly. Please ensure that your toolchains are up to date:
+
+```
+rustup update
+```
+
+You will also need [`probe-run`](https://ferrous-systems.com/blog/probe-run/) - a utility to enable `cargo run` to run embedded applications on a device:
+
+```
+cargo install probe-run
+```
+
## Running examples
-Instructions for S140 and nrf52840-dk. You may have to adjust accordingly.
+The following instructions are for the S140 and nRF52840-DK. You may have to adjust accordingly and can do so by modifying the `cargo.toml` of the examples folder -
+please check out the `nrf-softdevice` and `nrf-softdevice-s140` dependency declarations.
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.
@@ -51,9 +66,9 @@ Flashing the softdevice is required. It is NOT part of the built binary. You onl
- Unzip
- `nrfjprog --family NRF52 --chiperase --verify --program s140_nrf52_7.0.1_softdevice.hex`
-To run an example, simply use `cargo run`:
+To run an example, simply use `cargo run` from the `examples` folder:
-- `cargo run --bin ble_bas_peripheral`
+- `cd examples && cargo run --bin ble_bas_peripheral`
## Low-level raw bindings