mirror of
https://github.com/rust-embedded/awesome-embedded-rust.git
synced 2024-09-30 07:11:56 +00:00
Merge pull request #29 from rust-embedded/cleanup-post-merge
Cleanup post merge
This commit is contained in:
Daniel Egger
GitHub
commit
e108ed5127
3 changed files with 28 additions and 52 deletions
|
|
@ -2,12 +2,9 @@
|
|||
|
||||
Please note that this project is released with a [Contributor Code of Conduct](Code-of-Conduct.md). By participating in this project you agree to abide by its terms.
|
||||
|
||||
# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Adding to this list](#adding-to-this-list)
|
||||
- [Creating your own awesome list](#creating-your-own-awesome-list)
|
||||
- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
|
||||
- [Updating your Pull Request](#updating-your-pull-request)
|
||||
|
||||
|
|
@ -34,11 +31,11 @@ If you have something awesome to contribute to an awesome list, this is how you
|
|||
|
||||
You'll need a [GitHub account](https://github.com/join)!
|
||||
|
||||
1. Access the awesome list's GitHub page. For example: https://github.com/berkus/awesome-embedded-rust
|
||||
1. Access the awesome list's GitHub page. For example: https://github.com/rust-embedded/awesome-embedded-rust
|
||||
2. Click on the `readme.md` file: 
|
||||
3. Now click on the edit icon. 
|
||||
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). 
|
||||
5. Say why you're proposing the changes, and then click on "Propose file change". 
|
||||
5. Say why you're proposing the changes (see section [Adding to this list](#adding-to-this-list) for details), and then click on "Propose file change". 
|
||||
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
|
||||
|
||||
## Updating your Pull Request
|
||||
|
|
|
|||
|
|
@ -2,17 +2,11 @@
|
|||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
|
|
@ -22,53 +16,31 @@ include:
|
|||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at berkus@gmail.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Embedded WG. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
|
|
|
|||
21
README.md
21
README.md
|
|
@ -12,7 +12,6 @@ This is a curated list of resources related to embedded and low-level programmin
|
|||
* [Books, blogs and training materials](#books-blogs-and-training-materials)
|
||||
* [Tools](#tools)
|
||||
* [Device crates](#device-crates)
|
||||
* [ARM](#arm)
|
||||
* [Nordic](#nordic)
|
||||
* [NXP](#nxp)
|
||||
* [STMicroelectronics](#stmicroelectronics)
|
||||
|
|
@ -23,6 +22,8 @@ This is a curated list of resources related to embedded and low-level programmin
|
|||
* [NXP](#nxp-1)
|
||||
* [STMicroelectronics](#stmicroelectronics-1)
|
||||
* [Texas Instruments](#texas-instruments)
|
||||
* [Architecture support crates](#architecture-support-crates)
|
||||
* [ARM](#arm)
|
||||
* [Board support crates](#board-support-crates)
|
||||
* [Nordic](#nordic-2)
|
||||
* [NXP](#nxp-2)
|
||||
|
|
@ -36,10 +37,12 @@ This is a curated list of resources related to embedded and low-level programmin
|
|||
|
||||
## Community
|
||||
|
||||
In 2018 Mozilla asked for creation of an embedded workgroup to help drive adoption in the Rust ecosystem.
|
||||
In 2018 Rust community has created an embedded workgroup to help drive adoption in the Rust ecosystem.
|
||||
|
||||
- [Embedded WG](https://github.com/rust-lang-nursery/embedded-wg/), including newsletters with progress updates.
|
||||
|
||||
- You can usually find the members of the embedded WG on the `#rust-embedded` channel (server: `irc.mozilla.org`).
|
||||
|
||||
- [embedded.rs](https://t.me/embedded_rs) Telegram chat about Rust for microcontrollers in Russian language.
|
||||
|
||||
## Books, blogs and training materials
|
||||
|
|
@ -79,14 +82,9 @@ Register definition for microcontroller families. Usually generated using [`svd2
|
|||
|
||||
[svd2rust-kw]: https://crates.io/keywords/svd2rust
|
||||
|
||||
### ARM
|
||||
|
||||
- [`cortex-m`](https://github.com/japaric/cortex-m) Low level access to Cortex-M processors
|
||||
|
||||
### Nordic
|
||||
|
||||
- [`nrf51`](https://crates.io/crates/nrf51) Peripheral access API for nRF51 microcontrollers (generated using svd2rust) - 
|
||||
- [`nrf51822` playground](https://github.com/japaric/nrf51822) A crate to play with the nrf51822 module
|
||||
|
||||
### NXP
|
||||
|
||||
|
|
@ -104,6 +102,7 @@ Register definition for microcontroller families. Usually generated using [`svd2
|
|||
- [`stm32l151`](https://crates.io/crates/stm32l151) - 
|
||||
|
||||
### MSP430
|
||||
|
||||
- [`msp430g2553`](https://github.com/japaric/msp430g2553) Peripheral access API for MSP430G2553 microcontrollers (generated using svd2rust)
|
||||
- [rust on msp](https://github.com/japaric/rust_on_msp) Simple blinking LED example that runs on MSP430.
|
||||
- [msp430 quickstart](https://github.com/japaric/msp430-quickstart) some examples for msp430
|
||||
|
|
@ -168,6 +167,14 @@ Also check the list of [STMicroelectronics board support crates][stm-bsc]!
|
|||
|
||||
[Blue pill]: http://wiki.stm32duino.com/index.php?title=Blue_Pill
|
||||
|
||||
## Architecture support crates
|
||||
|
||||
Crates tailored for general CPU architectures.
|
||||
|
||||
### ARM
|
||||
|
||||
- [`cortex-m`](https://github.com/japaric/cortex-m) Low level access to Cortex-M processors
|
||||
|
||||
## Board support crates
|
||||
|
||||
Crates tailored for specific development boards.
|
||||
|
|
|
|||
Loading…
Reference in a new issue