Skip to content

Commit f91f1c3

Browse files
authored
Merge pull request #756 from RustAudio/call_for_contributions
Mention docs and reviews in contributing section
2 parents d878e89 + d95b876 commit f91f1c3

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,17 @@ Through cpal rodio depends on the alsa library (libasound & libasound-dev), this
5353
- Install the [multi-arch](https://wiki.debian.org/Multiarch/HOWTO) version of libasound2-dev for arm64 using: `sudo apt install libasound2-dev:arm64`
5454
- Build with the pkg config sysroot set to /usr/aarch64-linux-gnu and aarch64-linux-gnu as linker: `PKG_CONFIG_SYSROOT_DIR=/usr/aarch64-linux-gnu RUSTFLAGS="-C linker=aarch64-linux-gnu-gcc" cargo build --target aarch64-unknown-linux-gnu`
5555

56-
This will work for other Linux targets too if you change the architecture in the
57-
command and if there are multi-arch packages available.
56+
This will work for other Linux targets too if you change the architecture in the command and if there are multi-arch packages available.
5857

59-
You might want to look at [cross](https://github.com/cross-rs/cross) if you are
60-
running on a non debian system or want to make this more repeatable.
58+
You might want to look at [cross](https://github.com/cross-rs/cross) if you are running on a non debian system or want to make this more repeatable.
6159

6260
# Contributing
6361

64-
For information on how to contribute to this project, please see our [Contributing Guide](CONTRIBUTING.md).
62+
We love it when people join making rodio better. There are many ways to help not matter how experienced you are with audio or Rust. We would especially love help with:
63+
64+
- Reviewing PR's: we rely on the community to keep rodio correct, fast and maintainable. Absolutely anyone is welcome to leave reviews. Anyone can catch missing or unnecessary tests, unclear docs logic mistakes etc.
65+
- Improving the docs: You only learn something for the first time once. Many of us forgot what was hard when things where new. Your experience using rodio for the first time can really help out here. You probably know best what needs clearification and how it should be written down. It can be anything, maybe a paragraph on audio theory or an extra example.
66+
- Adding features: we love it when we get new features or existing onces get even better. Let us know what you are working on early. Not only can the rest of the community help out with the design we can help make the review and merge smooth. Please see our [Contributing Guide](CONTRIBUTING.md) for more to get you started.
6567

6668
## License
6769
[License]: #license

0 commit comments

Comments
 (0)