max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #541 from lulf/docs-readme

Browse Source 
Some notes in the readme about docs
This commit is contained in:
Dario Nieuwenhuis 2021-12-13 13:25:26 +01:00 committed by GitHub
commit 3f3b7d066e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,7 +1,6 @@
# Embassy
Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to
get started, click [here](https://github.com/embassy-rs/embassy/wiki).
Embassy 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).
## Traits and types
@ -93,6 +92,10 @@ Required nightly version is specified in the `rust-toolchain.toml` file. Nightly
Stable support is a non-goal until these features get stabilized.
## Documentation
Embassy 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.
## Why the name?
EMBedded ASYnc! :)