Update README with new Contact/CoC blocks
Taken from the rp-hal repo, for consistency.
This commit is contained in:
parent
9d3b0cef3a
commit
a0fd4ff52e
47
README.md
47
README.md
@ -43,13 +43,50 @@ For a release build
|
|||||||
DEFMT_LOG=trace cargo run --release
|
DEFMT_LOG=trace cargo run --release
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<!-- ROADMAP -->
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
NOTE These packages are under active development. As such, it is likely to
|
||||||
|
remain volatile until a 1.0.0 release.
|
||||||
|
|
||||||
|
See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of
|
||||||
|
proposed features (and known issues).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||||
|
|
||||||
|
The steps are:
|
||||||
|
|
||||||
|
1. Fork the Project by clicking the 'Fork' button at the top of the page.
|
||||||
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. Make some changes to the code or documentation.
|
||||||
|
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
|
5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
|
||||||
|
6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal/pulls)
|
||||||
|
7. An admin will review the Pull Request and discuss any changes that may be required.
|
||||||
|
8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
Contribution to this crate is organized under the terms of the [Rust Code of
|
||||||
|
Conduct][CoC], and the maintainer of this crate, the [rp-rs team], promises
|
||||||
|
to intervene to uphold that code of conduct.
|
||||||
|
|
||||||
|
[CoC]: CODE_OF_CONDUCT.md
|
||||||
|
[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under either of
|
The contents of this repository are dual-licensed under the _MIT OR Apache
|
||||||
|
2.0_ License. That means you can chose either the MIT licence or the
|
||||||
|
Apache-2.0 licence when you re-use this code. See `MIT` or `APACHE2.0` for more
|
||||||
|
information on each specific licence.
|
||||||
|
|
||||||
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
|
Any submissions to this project (e.g. as Pull Requests) must be made available
|
||||||
http://www.apache.org/licenses/LICENSE-2.0)
|
under these terms.
|
||||||
|
|
||||||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
## Contact
|
||||||
|
|
||||||
at your option.
|
Raise an issue: [https://github.com/rp-rs/rp2040-project-template/issues](https://github.com/rp-rs/rp2040-project-template/issues)
|
||||||
|
Chat to us on Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user