https://github.com/rust-embedded/discovery-mb2
Rust Discovery Book for BBC micro::bit v2
https://github.com/rust-embedded/discovery-mb2
Last synced: 8 days ago
JSON representation
Rust Discovery Book for BBC micro::bit v2
- Host: GitHub
- URL: https://github.com/rust-embedded/discovery-mb2
- Owner: rust-embedded
- License: apache-2.0
- Created: 2024-06-25T20:16:40.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-05-29T16:03:54.000Z (21 days ago)
- Last Synced: 2025-05-29T17:47:42.751Z (21 days ago)
- Language: Rust
- Homepage:
- Size: 10.4 MB
- Stars: 18
- Watchers: 7
- Forks: 15
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `micro::bit v2 Embedded Discovery Book`
The published text of this book is at
for your
perusing pleasure.
-----
Discover the world of microcontrollers through
[Rust](https://www.rust-lang.org/)! This book provides an
introduction to microcontrollers and how to use Rust with
them.
## Book Versions
This book is the current and best-maintained version of the
Rust Embedded Discovery Book. It is intended to be used with
the [BBC Micro:Bit v2](https://microbit.org/new-microbit/)
(MB2) development circuit board.
(There are currently two *deprecated* older versions of this
book. [One
version](https://docs.rust-embedded.org/discovery/f3discovery)
is based on the [STM F3
Discovery](https://www.st.com/en/evaluation-tools/stm32f3discovery.html)
development board. The [second
version](https://docs.rust-embedded.org/discovery/microbit)
is slightly newer and is based on the [BBC Micro:Bit
v1](https://microbit.org/get-started/features/overview/#original-micro:bit)
and v2 circuit boards. Unless you are determined to work
with older and less-well-supported hardware, and
corresponding older and less-well-supported books, we
recommend getting an MB2 and using this book instead. The
MB2 is available for about US$20 from many online
suppliers.)
## What Do You Want To Do?
Here's some ways to get started:
- Work through [this
book](https://docs.rust-embedded.org/discovery-mb2) with
an MB2
- Start working on the examples from this repository
- You've got questions?
- Have a look at our [discussions section on
GitHub](https://github.com/rust-embedded/discovery-mb2/discussions)
- Maybe it has already been answered
- If not, start a new discussion
- You've found an issue?
- Have a look at our [issues on
GitHub](https://github.com/rust-embedded/discovery-mb2/issues)
- Maybe there is already a workaround
- If not, please open a new one - or even better - a [pull
request](https://github.com/rust-embedded/discovery-mb2/pulls) for solving
it
- You want to talk to a human being directly?
- The general Rust [Embedded Matrix
chat](https://matrix.to/#/#rust-embedded:matrix.org)
is good for questions beyond the basics. Please be
respectful of the bandwidth of folks there, though:
it's a busy place
Have fun and enjoy!
This project is developed and maintained by the [Resources team][team].
## License
The documentation is licensed under
- Creative Commons Attribution 4.0 License ([LICENSE-CC-BY](LICENSE-CC-BY)
or https://creativecommons.org/licenses/by/4.0/legalcode)
And the source code is licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT License ([LICENSE-MIT](LICENSE-MIT) or
https://opensource.org/licenses/MIT)
at your option.
### 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.
## Code of Conduct
Contribution to this crate is organized under the terms of
the [Rust Code of Conduct][CoC], the maintainer of this
crate, the [Resources team][team], promises to intervene to
uphold that code of conduct.
[CoC]: CODE_OF_CONDUCT.md
[team]: https://github.com/rust-embedded/wg#the-resources-team
## Translations
We are extremely grateful to those who have provided
translations of this book: more are welcome.
Note that these translations are of the older versions
referenced above, and may not be monitored for accuracy or
currency.
* [Japanese](https://tomoyuki-nakabayashi.github.io/discovery/)
([repository](https://github.com/tomoyuki-nakabayashi/discovery))
* [Chinese](https://jzow.github.io/discovery/)
([repository](https://github.com/jzow/discovery))
* [Portuguese (Brazilian)](https://allyssan.github.io/discovery/)
([repository](https://github.com/allyssan/discovery))