aboutsummaryrefslogtreecommitdiff
path: root/rtic-time/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rtic-time/README.md')
-rw-r--r--rtic-time/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/rtic-time/README.md b/rtic-time/README.md
new file mode 100644
index 0000000..53c2944
--- /dev/null
+++ b/rtic-time/README.md
@@ -0,0 +1,29 @@
+# rtic-time
+
+Basic definitions and utilities that can be used to keep track of time.
+
+[![crates.io](https://img.shields.io/crates/v/rtic-time)](https://crates.io/crates/rtic-time)
+[![docs.rs](https://docs.rs/rtic-time/badge.svg)](https://docs.rs/rtic-time)
+[![matrix](https://img.shields.io/matrix/rtic:matrix.org)](https://matrix.to/#/#rtic:matrix.org)
+
+
+## Content
+
+The main contribution of this crate is to define the [`Monotonic`](https://docs.rs/rtic-time/latest/rtic_time/trait.Monotonic.html) trait. It serves as a standardized interface for libraries to interact with the system's monotonic timers.
+
+Additionally, this crate provides tools and utilities that help with implementing monotonic timers.
+
+## Implementations of the `Monotonic` trait
+
+For implementations of [`Monotonic`](https://docs.rs/rtic-time/latest/rtic_time/trait.Monotonic.html)
+on various hardware, see [`rtic-monotonics`](https://docs.rs/rtic-monotonics/).
+
+
+## Chat
+
+Join us and talk about RTIC in the [Matrix room][matrix-room].
+
+Weekly meeting minutes can be found over at [RTIC HackMD][hackmd].
+
+[matrix-room]: https://matrix.to/#/#rtic:matrix.org
+[hackmd]: https://rtic.rs/meeting