aboutsummaryrefslogtreecommitdiff
path: root/examples/teensy4_blinky/README.md
diff options
context:
space:
mode:
authorFinomnis <finomnis@gmail.com>2023-11-01 12:13:25 +0100
committerEmil Fresk <emil.fresk@gmail.com>2023-11-08 19:43:09 +0000
commit2fd3b3c4042dd7bffc5387f589a6aef3cf44a8cb (patch)
tree255b2fa14a3b1e98e5be52ffb7240d91121cf2c1 /examples/teensy4_blinky/README.md
parenta7f81262f631d19762cca1fd59c3ed2d8ad12d91 (diff)
Add Monotonic for i.MX RT chip family
Diffstat (limited to 'examples/teensy4_blinky/README.md')
-rw-r--r--examples/teensy4_blinky/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/teensy4_blinky/README.md b/examples/teensy4_blinky/README.md
new file mode 100644
index 0000000..778e712
--- /dev/null
+++ b/examples/teensy4_blinky/README.md
@@ -0,0 +1,25 @@
+# Teensy4 RTIC Blink example
+
+Working example of simple LED blinking application for Teensy4. Example uses monotonics API and peripherials access.
+
+## How-to
+
+### Prerequisites
+
+The following hardware is required for the examples:
+- A [Teensy 4.0](https://www.pjrc.com/store/teensy40.html)/[Teensy 4.1](https://www.pjrc.com/store/teensy41.html)/[Teensy MicroMod](https://www.sparkfun.com/products/16402) development board
+
+The following software tools have to be installed:
+- Python3 (as `python3`, or modify `run.py` to use the `python` binary)
+- [`cargo-binutils`](https://crates.io/crates/cargo-binutils)
+- [`teensy_loader_cli`](https://www.pjrc.com/teensy/loader_cli.html)
+
+
+### Run
+
+- Connect the Teensy to PC via USB cable.
+- Press the `Reset`/`Boot` button on the Teensy.
+- Run:
+ ```bash
+ cargo run --release
+ ```