aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2021-12-13 13:23:18 +0100
committerUlf Lilleengen <[email protected]>2021-12-13 13:23:18 +0100
commit91e0c6df73312ffd92bb1dc4b262307fcd2ce8c0 (patch)
treee936ebbf8600a69187aa16e7e94389e586fde2da /README.md
parent2a4a133b88402a513f1e2cbdd1c5dc29d057b8d5 (diff)
Some notes in the readme about docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index fd856bb6d..62aea0064 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
1# Embassy 1# Embassy
2 2
3Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to 3Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to get started, go to [https://embassy.dev](https://embassy.dev).
4get started, click [here](https://github.com/embassy-rs/embassy/wiki).
5 4
6## Traits and types 5## Traits and types
7 6
@@ -93,6 +92,10 @@ Required nightly version is specified in the `rust-toolchain.toml` file. Nightly
93 92
94Stable support is a non-goal until these features get stabilized. 93Stable support is a non-goal until these features get stabilized.
95 94
95## Documentation
96
97Embassy documentation is located in the `docs/` folder. The documentation is built in [embassy-book](https://github.com/embassy-rs/embassy-book) and published to [https://embassy.dev](https://embassy.dev) by CI.
98
96## Why the name? 99## Why the name?
97 100
98EMBedded ASYnc! :) 101EMBedded ASYnc! :)