aboutsummaryrefslogtreecommitdiff
path: root/rtic-monotonics/README.md
diff options
context:
space:
mode:
authorDan Whitman <dwhitman44@gmail.com>2025-01-24 15:08:52 -0500
committerGitHub <noreply@github.com>2025-01-24 20:08:52 +0000
commit0935051d8b35f79d85475fa3449315f31faf469d (patch)
tree057667f98432f3b8fc10c9cee305741c9f0c5703 /rtic-monotonics/README.md
parent26b1ab05eb5a444d0c2d723963b5459589a0c28b (diff)
ATSAMD RTC monotonic referral in documentation (#1014)
* rtic-monotonics: Adds a section to the module documentation about ATSAMD chip monotonics provided in the `atsamd-hal` crate * rtic-monotonics: Adds a section to README listing the supported microcontroller platforms. * rtic-sync: Fix clippy complaints error: the following explicit lifetimes could be elided: 'a --> rtic-sync/src/signal.rs:113:6 | 113 | impl<'a, T: Copy> SignalReader<'a, T> { | ^^ ^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes = note: `-D clippy::needless-lifetimes` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::needless_lifetimes)]` help: elide the lifetimes | 113 - impl<'a, T: Copy> SignalReader<'a, T> { 113 + impl<T: Copy> SignalReader<'_, T> { * xtask: Clippy fix warning warning: elided lifetime has a name --> xtask/src/cargo_command.rs:427:14 | 420 | fn build_args<'i, T: Iterator<Item = &'i str>>( | -- lifetime `'i` declared here ... 427 | ) -> Vec<&str> { | ^ this elided lifetime gets resolved as `'i` | = note: `#[warn(elided_named_lifetimes)]` on by default --------- Co-authored-by: Dan Whitman <daniel.whitman.2@us.af.mil> Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'rtic-monotonics/README.md')
-rw-r--r--rtic-monotonics/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/rtic-monotonics/README.md b/rtic-monotonics/README.md
index 31a3922..caaf5f6 100644
--- a/rtic-monotonics/README.md
+++ b/rtic-monotonics/README.md
@@ -15,6 +15,16 @@ For RTIC v1 see [`rtic-monotonic`](https://github.com/rtic-rs/rtic-monotonic)
### [Changelog `rtic-monotonics`](https://github.com/rtic-rs/rtic/blob/master/rtic-monotonics/CHANGELOG.md)
+## Supported Platforms
+
+The following microcontroller families feature efficient monotonics using peripherals.
+Refer to the [crate documentation](https://docs.rs/rtic-monotonics) for more details.
+
+- RP2040
+- i.MX RT
+- nRF
+- ATSAMD
+
## License
Licensed under either of