aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenrik Tjäder <henrik@tjaders.com>2025-01-22 20:41:42 +0100
committerGitHub <noreply@github.com>2025-01-22 19:41:42 +0000
commit26b1ab05eb5a444d0c2d723963b5459589a0c28b (patch)
treeea49f3940ea7913fa64a1d65851cee2eda2a832f
parent1a8b5f27a05a63df9c61b6a9cadd4b0729557e96 (diff)
monotonics add readme (#1012)
* rtic-monotonics: Add README * rtic-monotonics: Add links to changelog
-rw-r--r--rtic-monotonics/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/rtic-monotonics/README.md b/rtic-monotonics/README.md
new file mode 100644
index 0000000..31a3922
--- /dev/null
+++ b/rtic-monotonics/README.md
@@ -0,0 +1,33 @@
+[![crates.io](https://img.shields.io/crates/v/rtic-monotonics.svg)](https://crates.io/crates/rtic-monotonics)
+[![crates.io](https://img.shields.io/crates/d/rtic-monotonics.svg)](https://crates.io/crates/rtic-monotonics)
+
+# `rtic-monotonics`
+
+> Core abstractions of the Real-Time Interrupt-driven Concurrency (RTIC) Monotonics timers
+
+`rtic-monotonics` is for RTIC v2.
+
+For RTIC v1 see [`rtic-monotonic`](https://github.com/rtic-rs/rtic-monotonic)
+
+## [Documentation](https://docs.rs/rtic-monotonics)
+
+[RTIC book: chapter on monotonics](https://rtic.rs/2/book/en/by-example/delay.html)
+
+### [Changelog `rtic-monotonics`](https://github.com/rtic-rs/rtic/blob/master/rtic-monotonics/CHANGELOG.md)
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+ http://www.apache.org/licenses/LICENSE-2.0)
+
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or 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.