Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Add notice for systems without native CAS operations
  • Loading branch information
robamu committed Sep 18, 2024
1 parent 67c2286 commit 2e06aa5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions rtic-monotonics/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
//! In-tree implementations of the [`rtic_time::Monotonic`] (reexported) trait for
//! timers & clocks found on commonly used microcontrollers.
//!
//! If you are using a microcontroller where CAS operations are not available natively, you might
//! have to enable the `critical-section` or `unsafe-assume-single-core` feature of the
//! [`portable-atomic`](https://docs.rs/portable-atomic/latest/portable_atomic/) dependency
//! yourself for this dependency to compile.
//!
//! To enable the implementations, you must enable a feature for the specific MCU you're targeting.
//!
//! # Cortex-M Systick
Expand Down

0 comments on commit 2e06aa5

Please sign in to comment.