diff options
| -rw-r--r-- | Cargo.toml | 2 | ||||
| -rw-r--r-- | README.md | 7 | ||||
| -rw-r--r-- | book/en/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | book/en/src/by-example/app.md | 2 | ||||
| -rw-r--r-- | book/en/src/by-example/new.md | 2 | ||||
| -rw-r--r-- | book/en/src/by-example/tasks.md | 2 | ||||
| -rw-r--r-- | book/en/src/by-example/tips.md | 4 | ||||
| -rw-r--r-- | book/en/src/preface.md | 2 |
8 files changed, 14 insertions, 8 deletions
@@ -5,7 +5,7 @@ authors = [ "Per Lindgren <per.lindgren@ltu.se>", ] categories = ["concurrency", "embedded", "no-std"] -description = "Real-Time Interrupt-driven Concurrency (RTIC): a concurrency framework for building real time systems" +description = "Real-Time Interrupt-driven Concurrency (RTIC): a concurrency framework for building real-time systems" documentation = "https://rtic.rs/" edition = "2018" keywords = ["arm", "cortex-m"] @@ -1,9 +1,14 @@ # 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. + + + + + ## Features - **Tasks** as the unit of concurrency [^1]. Tasks can be *event triggered* diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 305c1a0e..25aef811 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -1,6 +1,7 @@ # Summary [Preface](./preface.md) + - [RTIC by example](./by-example.md) - [The `app` attribute](./by-example/app.md) - [Resources](./by-example/resources.md) diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md index bff516d2..e0f4f941 100644 --- a/book/en/src/by-example/app.md +++ b/book/en/src/by-example/app.md @@ -90,7 +90,7 @@ $ cargo run --example idle To declare interrupt handlers the framework provides a `#[task]` attribute that can be attached to functions. This attribute takes a `binds` argument whose value is the name of the interrupt to which the handler will be bound to; the -function adornated with this attribute becomes the interrupt handler. Within the +function adorned with this attribute becomes the interrupt handler. Within the framework these type of tasks are referred to as *hardware* tasks, because they start executing in reaction to a hardware event. diff --git a/book/en/src/by-example/new.md b/book/en/src/by-example/new.md index c0482b09..abcc36de 100644 --- a/book/en/src/by-example/new.md +++ b/book/en/src/by-example/new.md @@ -48,7 +48,7 @@ Here I'll use the `init` example from the `cortex-m-rtic` crate. ``` console $ curl \ - -L https://github.com/rtic-rs/cortex-m-rtic/raw/v0.5.0/examples/init.rs \ + -L https://github.com/rtic-rs/cortex-m-rtic/raw/v0.5.3/examples/init.rs \ > src/main.rs ``` diff --git a/book/en/src/by-example/tasks.md b/book/en/src/by-example/tasks.md index 5978ca83..d0b5acb9 100644 --- a/book/en/src/by-example/tasks.md +++ b/book/en/src/by-example/tasks.md @@ -78,7 +78,7 @@ message. In most scenarios spawning errors are handled in one of two ways: platform can deal with peak payload or if the processor needs to be replaced with a faster one. -- Ignoring the result. In soft real time and non real time applications it may +- Ignoring the result. In soft real-time and non real-time applications it may be OK to occasionally lose data or fail to respond to some events during event bursts. In those scenarios silently letting a `spawn` call fail may be acceptable. diff --git a/book/en/src/by-example/tips.md b/book/en/src/by-example/tips.md index ce9bba82..b191b9da 100644 --- a/book/en/src/by-example/tips.md +++ b/book/en/src/by-example/tips.md @@ -155,7 +155,7 @@ const APP: () = { }; ``` -Or, you can use the [`cargo-expand`] subcommand. This subcommand will expand +Or, you can use the [`cargo-expand`] sub-command. This sub-command will expand *all* the macros, including the `#[rtic::app]` attribute, and modules in your crate and print the output to the console. @@ -169,7 +169,7 @@ $ cargo expand --example smallest | tail ## Resource de-structure-ing When having a task taking multiple resources it can help in readability to split -up the resource struct. Here're two examples on how this can be done: +up the resource struct. Here are two examples on how this can be done: ``` rust {{#include ../../../../examples/destructure.rs}} diff --git a/book/en/src/preface.md b/book/en/src/preface.md index 6563dd4d..419f067e 100644 --- a/book/en/src/preface.md +++ b/book/en/src/preface.md @@ -1,6 +1,6 @@ <h1 align="center">Real-Time Interrupt-driven Concurrency</h1> -<p align="center">A concurrency framework for building real time systems</p> +<p align="center">A concurrency framework for building real-time systems</p> # Preface |