Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://esp-rs.github.io/book
The Rust on ESP Book
https://esp-rs.github.io/book
book embedded esp-rs esp32 espressif mdbook rust
Last synced: about 2 months ago
JSON representation
The Rust on ESP Book
- Host: GitHub
- URL: https://esp-rs.github.io/book
- Owner: esp-rs
- License: apache-2.0
- Created: 2021-09-16T21:32:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T09:28:54.000Z (about 2 months ago)
- Last Synced: 2024-09-12T20:32:34.616Z (about 2 months ago)
- Topics: book, embedded, esp-rs, esp32, espressif, mdbook, rust
- Language: JavaScript
- Homepage: https://esp-rs.github.io/book/
- Size: 2.31 MB
- Stars: 169
- Watchers: 11
- Forks: 53
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-embedded-rust - The Rust on ESP Book - This book aims to provide a comprehensive guide on using the Rust programming language with Espressif SoCs and modules. (Books, blogs, and training materials / Free and public materials)
README
# The Rust on ESP Book
This repository contains the source of "The Rust on ESP" book.
## Quickstart
This book is generated using [`mdbook`] and additionally uses the [`mdbook-mermaid`] preprocessor to add support for diagrams. To install these tools:
```shell
cargo install mdbook mdbook-mermaid
```
With `mdbook` and `mdbook-mermaid` installed, you can clone the repository and start a development server by running:
```shell
git clone https://github.com/esp-rs/book
cd book/
mdbook serve
```
[`mdbook`]: https://github.com/rust-lang/mdBook
[`mdbook-mermaid`]: https://github.com/badboy/mdbook-mermaid
## License
The Rust on ESP Book is distributed under the following licenses:
- The code samples contained within this book are licensed under the terms of
both the [MIT License] and the [Apache License v2.0].
- The written prose contained within this book is licensed under the terms of
the Creative Commons [CC-BY-SA v4.0] license.
[mit license]: ./LICENSE-MIT
[apache license v2.0]: ./LICENSE-APACHE
[cc-by-sa v4.0]: ./LICENSE-CC-BY-SA
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any
additional terms or conditions.
While contributing, please follow the [Rust Documentation Style Guide](rust-doc-style-guide.md).