book

Documentation on how to use the Rust Programming Language to develop firmware for bare metal (microcontroller) devices

https://github.com/rust-embedded/book

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Documentation on how to use the Rust Programming Language to develop firmware for bare metal (microcontroller) devices

Basic Info
Statistics
  • Stars: 1,194
  • Watchers: 34
  • Forks: 194
  • Open Issues: 74
  • Releases: 0
Created over 7 years ago · Last pushed 8 months ago
Metadata Files
Readme License Code of conduct Citation Codeowners

README.md

The Embedded Rust Book

Documentation on how to use the Rust Programming Language to develop firmware for bare metal (microcontroller) devices

This project is developed and maintained by the Resources team.

See the issue tracker for more details. This book is a living document, and is updated continuously.

Online Copies of this Book

This book is located at https://docs.rust-embedded.org/book/

License

The Embedded Rust Book (this project) is distributed under the following licenses:

  • The code samples and free-standing Cargo projects 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.

Copies of the licenses used by this project may also be found here:

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, the maintainer of this crate, the Resources team, promises to intervene to uphold that code of conduct.

Owner

  • Name: Rust Embedded
  • Login: rust-embedded
  • Kind: organization

Enabling usage of Rust on Embedded Platforms (Embedded Linux / RTOS / Bare Metal)

Citation (CITATION.bib)

@booklet{embedded-rust-book,
  title = {The Embedded Rust Book},
  author = {{Rust on Embedded Devices Working Group} and others},
  date = {}, % intentionally left empty because the book has no 'publication date'
  url = {https://docs.rust-embedded.org/book/},
  urldate = {}, % fill this in manually
}

GitHub Events

Total
  • Issues event: 7
  • Watch event: 99
  • Delete event: 5
  • Issue comment event: 16
  • Push event: 9
  • Pull request review comment event: 5
  • Pull request review event: 13
  • Pull request event: 15
  • Fork event: 19
  • Create event: 4
Last Year
  • Issues event: 7
  • Watch event: 99
  • Delete event: 5
  • Issue comment event: 16
  • Push event: 9
  • Pull request review comment event: 5
  • Pull request review event: 13
  • Pull request event: 15
  • Fork event: 19
  • Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 90
  • Total pull requests: 120
  • Average time to close issues: 9 months
  • Average time to close pull requests: 22 days
  • Total issue authors: 59
  • Total pull request authors: 61
  • Average comments per issue: 3.83
  • Average comments per pull request: 2.65
  • Merged pull requests: 106
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 12
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 9 days
  • Issue authors: 5
  • Pull request authors: 9
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.25
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • japaric (17)
  • flip111 (6)
  • thejpster (3)
  • jamesmunns (3)
  • therealprof (3)
  • jonathanpallant (2)
  • abt8601 (2)
  • cocoacrumbs (2)
  • adamgreig (2)
  • aguynamedben (1)
  • Jzow (1)
  • scorpasdzx (1)
  • koen-intercel (1)
  • klotzambein (1)
  • RandomInsano (1)
Pull Request Authors
  • japaric (21)
  • adamgreen (10)
  • jamesmunns (7)
  • therealprof (7)
  • adamgreig (5)
  • diepes (4)
  • Nicoretti (3)
  • neilpate (3)
  • BenBergman (3)
  • thejpster (3)
  • gdamjan (2)
  • njmartin10 (2)
  • HosseinAssaran (2)
  • busslina (2)
  • rxwb (2)
Top Labels
Issue Labels
help wanted (8) Blocks Rust 2018 (7) book (7) docs (2) good first issue (2) blocked (1) T-resources (1) bug (1) enhancement (1)
Pull Request Labels
T-resources (36) S-waiting-on-review (31) S-waiting-on-author (4) help wanted (1) Blocks Rust 2018 (1) book (1)

Dependencies

.github/workflows/ci.yml actions
  • actions-rs/install v0.1 composite
  • actions-rs/toolchain v1 composite
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • peaceiris/actions-gh-pages v3 composite