aboutsummaryrefslogtreecommitdiff
path: root/examples/stm32f411_rtc_interrupt/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--examples/stm32f411_rtc_interrupt/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/stm32f411_rtc_interrupt/README.md b/examples/stm32f411_rtc_interrupt/README.md
new file mode 100644
index 00000000..55b7a7d6
--- /dev/null
+++ b/examples/stm32f411_rtc_interrupt/README.md
@@ -0,0 +1,12 @@
+# STM32F411CEU6 RTC interrup example
+
+Working example to configure the internal RTC of the STM32F411CEU6 present on the Blackpill board.
+After configured, it will listen to periodic wake-up interrupts happening every 10 seconds until the button on GPIO PA0 is pressed.
+
+## 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.
+
+### Run
+Install `probe-rs` and configure it using the [debugging extension for VScode](https://probe.rs/docs/tools/debugger/).