Skip to content

Commit f1393ae

Browse files
authored
Merge pull request #69 from eldruin/note-cs-example
Add note about critical section to readme
2 parents 7625f74 + 4da66be commit f1393ae

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ fn main() -> ! {
4646

4747
For a full usage example, see [`examples/global_alloc.rs`](https://github.com/rust-embedded/embedded-alloc/blob/master/examples/global_alloc.rs).
4848

49+
For this to work, an implementation of [`critical-section`](https://github.com/rust-embedded/critical-section) must be provided.
50+
51+
For simple use cases you may enable the `critical-section-single-core` feature in the [cortex-m](https://github.com/rust-embedded/cortex-m) crate.
52+
Please refer to the documentation of [`critical-section`](https://docs.rs/critical-section) for further guidance.
53+
54+
4955
## License
5056

5157
Licensed under either of

0 commit comments

Comments
 (0)