aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authordatdenkikniet <jcdra1@gmail.com>2023-04-14 21:53:56 +0200
committerdatdenkikniet <jcdra1@gmail.com>2023-04-16 13:08:35 +0200
commit5a9135961f34505714e23f12e4cf4bacfa492dcd (patch)
tree14c986e17ee46a633ecce02d0f6b0c88ceb1c86b /examples/README.md
parentef8046b060a375fd5e6b23d62c3a9a303bbd6e11 (diff)
Split remove old examples
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..929d3f2
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,42 @@
+# `RTIC examples`
+
+> Here you can find examples on different aspects of the RTIC scheduler.
+
+## Structure
+
+This repo does have example applications based on RTIC framework for popular hardware platforms (for example nRF series and Bluepill).
+
+## Requirements
+
+To run these examples, you need to have working environment as described in [Installing the tools](https://rust-embedded.github.io/book/intro/install.html) chapter of **The Embedded Rust Book**.
+
+Short list:
+
+* Rust and cargo
+* Toolchain for your microcontroller
+* OpenOCD
+
+## Contributing
+New examples are always welcome!
+
+## External examples
+
+Some projects maintain RTIC examples in their own repository. Follow these links to find more RTIC examples.
+
+- The [`teensy4-rs` project](https://github.com/mciantyre/teensy4-rs) maintains `RTIC v1.0` examples that run on the Teensy 4.0 and 4.1.
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+ [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.