aboutsummaryrefslogtreecommitdiff
path: root/examples/stm32f3_blinky/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/stm32f3_blinky/README.md')
-rw-r--r--examples/stm32f3_blinky/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/stm32f3_blinky/README.md b/examples/stm32f3_blinky/README.md
new file mode 100644
index 0000000..5152661
--- /dev/null
+++ b/examples/stm32f3_blinky/README.md
@@ -0,0 +1,19 @@
+# STM32F3 RTIC Blink example
+
+Working example of simple LED blinking application for STM32 F303 Nucleo-64 board based on the STM32F303RE chip. Example uses schedule API and peripherials access. This example is based on blue-pill blinky example.
+
+## How-to
+
+### Build
+
+Run `cargo +nightly build` to compile the code. If you run it for the first time, it will take some time to download and compile dependencies.
+
+After that, you can use for example the cargo-embed tool to flash and run it
+
+```bash
+$ cargo +nightly embed
+```
+
+### Setup environment, flash and run program
+
+In the [Discovery Book](https://rust-embedded.github.io/discovery) you find all needed informations to setup the environment, flash the controler and run the program.