aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 24 insertions, 9 deletions
diff --git a/README.md b/README.md
index b8cbd00..18f968d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
-# Real Time For the Masses
+# Real-Time Interrupt-driven Concurrency
-A concurrency framework for building real time systems.
+A concurrency framework for building real-time systems.
+
+Formerly known as Real-Time For the Masses.
+
+[![crates.io](https://img.shields.io/crates/v/cortex-m-rtic)](https://crates.io/crates/cortex-m-rtic)
+[![docs.rs](https://docs.rs/cortex-m-rtic/badge.svg)](https://docs.rs/cortex-m-rtic)
+[![book](https://img.shields.io/badge/web-rtic.rs-red.svg?style=flat&label=book&colorB=d33847)](https://rtic.rs/)
+![rustc](https://img.shields.io/badge/rustc-1.36+-lightgray.svg)
## Features
@@ -31,9 +38,7 @@ A concurrency framework for building real time systems.
- **Highly efficient memory usage**: All the tasks share a single call stack and
there's no hard dependency on a dynamic memory allocator.
-- **All Cortex-M devices are supported**. The core features of RTFM are
- supported on all Cortex-M devices. The timer queue is currently only supported
- on ARMv7-M devices.
+- **All Cortex-M devices are fully supported**.
- This task model is amenable to known WCET (Worst Case Execution Time) analysis
and scheduling analysis techniques. (Though we haven't yet developed Rust
@@ -41,17 +46,27 @@ A concurrency framework for building real time systems.
## Requirements
-- Rust 1.31.0+
+- Rust 1.36.0+
- Applications must be written using the 2018 edition.
-## [User documentation](https://japaric.github.io/cortex-m-rtfm/book/en)
+## [User documentation](https://rtic.rs)
+
+## [API reference](https://rtic.rs/0.5/api/)
+
+## Chat
+Join us and talk about RTIC in the [Matrix room][matrix-room].
+
+[matrix-room]: https://matrix.to/#/#rtic:matrix.org
+
+## Contributing
+New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs].
-## [API reference](https://japaric.github.io/cortex-m-rtfm/api/rtfm/index.html)
+[rfcs]: https://github.com/rtic-rs/rfcs
## Acknowledgments
-This crate is based on [the RTFM language][rtfm-lang] created by the Embedded
+This crate is based on [the Real-Time For the Masses language][rtfm-lang] created by the Embedded
Systems group at [LuleƄ University of Technology][ltu], led by [Prof. Per
Lindgren][per].