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:

cargo install mdbook mdbook-mermaid

With mdbook and mdbook-mermaid installed, you can clone the repository and start a development server by running:

git clone https://github.com/esp-rs/book
cd book/
mdbook serve

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.

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.