aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVega Deftwing <[email protected]>2024-04-11 19:45:38 +0000
committerVega Deftwing <[email protected]>2024-04-11 19:45:38 +0000
commit9053b6b5b3a09e48ed5e2476a5f712c9796828d5 (patch)
treebabd8bcdabe0bc5ab595dde38672695f9e08f692 /README.md
parentf5f776f8157eca01cc4f3560807343889d8dcaef (diff)
Fix spelling and white space mistakes
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index b6f667f75..0bd1ac594 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Embassy is the next-generation framework for embedded applications. Write safe,
7 7
8The Rust programming language is blazingly fast and memory-efficient, with no runtime, garbage collector or OS. It catches a wide variety of bugs at compile time, thanks to its full memory- and thread-safety, and expressive type system. 8The Rust programming language is blazingly fast and memory-efficient, with no runtime, garbage collector or OS. It catches a wide variety of bugs at compile time, thanks to its full memory- and thread-safety, and expressive type system.
9 9
10Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows for unprecedently easy and efficient multitasking in embedded systems. Tasks get transformed at compile time into state machines that get run cooperatively. It requires no dynamic memory allocation, and runs on a single stack, so no per-task stack size tuning is required. It obsoletes the need for a traditional RTOS with kernel context switching, and is <a href="https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown">faster and smaller than one!</a> 10Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows for unprecedentedly easy and efficient multitasking in embedded systems. Tasks get transformed at compile time into state machines that get run cooperatively. It requires no dynamic memory allocation, and runs on a single stack, so no per-task stack size tuning is required. It obsoletes the need for a traditional RTOS with kernel context switching, and is <a href="https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown">faster and smaller than one!</a>
11 11
12## Batteries included 12## Batteries included
13 13
@@ -89,7 +89,7 @@ async fn main(spawner: Spawner) {
89 89
90## Examples 90## Examples
91 91
92Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on. For example: 92Examples are found in the `examples/` folder separated by the chip manufacturer they are designed to run on. For example:
93 93
94* `examples/nrf52840` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards. 94* `examples/nrf52840` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards.
95* `examples/nrf5340` run on the `nrf5340-dk` board (PCA10095). 95* `examples/nrf5340` run on the `nrf5340-dk` board (PCA10095).
@@ -130,8 +130,8 @@ For more help getting started, see [Getting Started][1] and [Running the Example
130## Developing Embassy with Rust Analyzer based editors 130## Developing Embassy with Rust Analyzer based editors
131 131
132The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/) 132The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/)
133and others. Given the multiple targets that Embassy serves, there is no Cargo workspace file. Instead, the Rust Analyzer 133and others. Given the multiple targets that Embassy serves, there is no Cargo workspace file. Instead, the Rust Analyzer
134must be told of the target project to work with. In the case of Visual Studio Code, 134must be told of the target project to work with. In the case of Visual Studio Code,
135please refer to the `.vscode/settings.json` file's `rust-analyzer.linkedProjects`setting. 135please refer to the `.vscode/settings.json` file's `rust-analyzer.linkedProjects`setting.
136 136
137## Minimum supported Rust version (MSRV) 137## Minimum supported Rust version (MSRV)