mirror of
https://github.com/embassy-rs/embassy.git
synced 2024-11-22 06:42:32 +00:00
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# embassy docs
|
|
|
|
The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can built running `make` in this folder:
|
|
|
|
```
|
|
make
|
|
```
|
|
|
|
Then open the generated file `thebook/index.html`.
|
|
|
|
## License
|
|
|
|
The Embassy Docs (this folder) is distributed under the following licenses:
|
|
|
|
* The code samples and free-standing Cargo projects contained within these docs are licensed under the terms of both the [MIT License] and the [Apache License v2.0].
|
|
* The written prose contained within these docs are licensed under the terms of the Creative Commons [CC-BY-SA v4.0] license.
|
|
|
|
Copies of the licenses used by this project may also be found here:
|
|
|
|
* [MIT License Hosted]
|
|
* [Apache License v2.0 Hosted]
|
|
* [CC-BY-SA v4.0 Hosted]
|
|
|
|
[MIT License]: ./../LICENSE-MIT
|
|
[Apache License v2.0]: ./../LICENSE-APACHE
|
|
[CC-BY-SA v4.0]: ./../LICENSE-CC-BY-SA
|
|
[MIT License Hosted]: https://opensource.org/licenses/MIT
|
|
[Apache License v2.0 Hosted]: http://www.apache.org/licenses/LICENSE-2.0
|
|
[CC-BY-SA v4.0 Hosted]: https://creativecommons.org/licenses/by-sa/4.0/legalcode
|