├── assets ├── logo │ └── rec-logo-250x250.png └── README.md ├── TRANSFER.md └── README.md /assets/logo/rec-logo-250x250.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rust-embedded-community/meta/HEAD/assets/logo/rec-logo-250x250.png -------------------------------------------------------------------------------- /assets/README.md: -------------------------------------------------------------------------------- 1 | # Rust Embedded Community Logos and other Assets 2 | 3 | Logos and other assets of the Rust Embedded Community are licensed under the [Creative Commons Attribution License (CC-BY)](https://creativecommons.org/licenses/by/4.0/). 4 | 5 | ## Attribution 6 | 7 | ### Logo 8 | 9 | The Rust Embedded Community Logo was designed by [Diego Barrios Romero]. It is based on the [Rust Embedded Working Group][rewg] Logo, which was designed by [Erin Power] but omitting the Rust language logo. These designs include all files matching `assets/logo/rec-logo*`. 10 | 11 | [rewg]: https://github.com/rust-embedded 12 | [Erin Power]: https://github.com/XAMPPRocky 13 | [Diego Barrios Romero]: https://github.com/eldruin -------------------------------------------------------------------------------- /TRANSFER.md: -------------------------------------------------------------------------------- 1 | # Instructions for Crate Transfer 2 | 3 | This document outlines the necessary steps to transfer a project to the rust-embedded-community 4 | project. 5 | 6 | Users that are interested in their transfer can retain original ownership and write-control to any 7 | projects that they wish to transfer as well. 8 | 9 | ## Process 10 | 11 | The process for transferring ownership depends on whether or not the original crate owner would like 12 | to join the `rust-embedded-community` project. 13 | 14 | ### Transfer Process (Joining the R-E-C) 15 | 16 | This process is used if the original crate owner would like to become a member of the 17 | `rust-embedded-community` project. 18 | 19 | 1. Request to join the community by following the steps outlined [here](README.md#joining-the-community). 20 | 1. Once you have been added, request to transfer the repository under the repository settings: 21 | 1. Navigate to transfer the repository under the repository settings. 22 | `https://github.com///settings`: General > Danger Zone > "Transfer 23 | ownership" 24 | 2. Select "Specify an organization or username" and supply `rust-embedded-community` 25 | 3. Confirm the transfer and select "I understand, transfer this repository" 26 | 27 | 2. Add the rust-embedded-community project to the crates.io owners to allow the community 28 | to issue updated releases for the crate: 29 | ```sh 30 | cargo owner --add github:rust-embedded-community:all 31 | ``` 32 | 33 | ### Transfer Process (Without Joining) 34 | 35 | The following process can be used if the original crate owner does not wish to join the 36 | `rust-embedded-community`. 37 | 38 | 1. Request to transfer the repository under the repository settings: 39 | 1. Navigate to transfer the repository under the repository settings. 40 | `https://github.com///settings`: General > Danger Zone > "Transfer 41 | ownership" 42 | 2. Select "Specify an organization or username" and supply the Github username of one of the 43 | `rust-embedded-community` members that you have been previously in contact with about 44 | transferring the repository. 45 | * If you haven't been in contact with anyone yet, feel free to [open an issue](https://github.com/rust-embedded-community/meta/issues/new) and one of us will be 46 | happy to assist. 47 | 3. Confirm the transfer and select "I understand, transfer this repository" 48 | 4. Add the contact person to the crates.io owners to allow them to allow the community 49 | to issue updated releases for the crate: 50 | ```sh 51 | cargo owner --add 52 | ``` 53 | 54 | Once the repository is transferred to the organizational member, that member should follow the steps 55 | outlined above for transferring to the `rust-embedded-comunity`. 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rust Embedded Community 2 | 3 | [](https://github.com/rust-embedded-community/meta) 4 | 5 | The [rust-embedded-community][REC] GitHub organization serves two purposes: increasing the bus factor of hosted crates and provide a place for centralized maturation of experimental crates which are meant to be widely used. 6 | 7 | For the official working group dedicated to [Rust] on embedded devices, please refer to the [Rust Embedded Working Group][REWG]. 8 | 9 | ## Detailed mission 10 | 11 | ### Home for projects in need of further maintenance 12 | 13 | There are libraries that were once developed but the original author does not have the time necessary for further development or has moved on to other projects. 14 | 15 | The REC provides a place for those of these libraries which are accepted to live on, offering the opportunity for development to be easily aided by or taken over by a group of interested people, also to increase the "bus factor". 16 | 17 | ### Centralized maturation of experimental crates 18 | 19 | The REC provides a place for crates to mature in a centralized way. That means a centralized organization where several people can collaborate in projects that are (still) too experimental but are meant to be widely-used. 20 | 21 | The shared ownership provided by this organization ensures that widely-used crates do not become unmaintained. 22 | 23 | ### Relation to the Rust Embedded Working Group organization 24 | 25 | The [Rust Embedded Working Group][REWG] is an official working group of the [Rust programming language][rust]. This organization is not. This organization should be seen as separate and "non-blessed". 26 | 27 | Sometimes, crates from this organization may be migrated to the [REWG] or integrated into [REWG] crates. However, that remains a process regulated by the [REWG] itself. 28 | 29 | ## The original idea 30 | 31 | Several members of the Rust Embedded Working Group got together at Oxidize 2019 and wondered, "what can we do with these half-finished projects we've started but never quite find the time to finish"? Rather than invite each other to all our repositories, we wondered if there could be a place where unloved crates could move in and get some of the care and attention they deserve. And so, the rust-embedded-community was born. 32 | 33 | ## Joining the community 34 | 35 | We need maintainers! If you're interested in updating some of the projects we care for, open an issue on this `meta` repo, or submit a PR on this README adding yourself to the Maintainers section. 36 | 37 | ## Adding a project 38 | 39 | We haven't really worked out any rules as to what we will and won't look after, but at the moment it's fair to say a project needs to be: 40 | 41 | * Written in the [Rust Programming Language][rust] 42 | * Target resource constrained devices (be they small Linux devices, RTOS based or bare-metal) 43 | * Useful to the wider Rust Embedded community (or at least, not just the author) 44 | * Licensed under an [OSI]-approved open-source license. 45 | 46 | If you'd like to suggest a project to be moved to the community, please open an issue and tell us about it. 47 | 48 | For detailed instructions on how to transfer repositories, please refer to [TRANSFER.md](TRANSFER.md). 49 | 50 | ## Crates.io 51 | 52 | We're happy to be added as Owners on crates.io for projects we host. We can then help co-ordinate pushing out updates when something elsewhere in the ecosystem causes breakage. Open an issue if you want to discuss this. 53 | 54 | Once approved, a maintainer can add the team by adding `github:rust-embedded-community:all`. Note that this can only be done by a member of the team, so you might first have to add one of them individually if you aren't one yourself. 55 | 56 | ## Maintainers 57 | 58 | * Jonathan 'theJPster' Pallant - [GitHub](https://github.com/thejpster) | [Twitter](https://twitter.com/therealjpster) | [Keybase](https://keybase.io/thejpster) 59 | * James Munns - [GitHub](https://github.com/jamesmunns) 60 | * Vadim Kaushan - [Github](https://github.com/disasm) 61 | * Diego Barrios Romero - [Github](https://github.com/eldruin) 62 | * Mathias Koch - [Github](https://github.com/MathiasKoch) 63 | * Ryan Summers - [GitHub](https://github.com/ryan-summers) 64 | * Matt Dunlap - [GitHub](https://github.com/dunmatt) 65 | * Jan Niehusmann - [Github](https://github.com/jannic) 66 | * Scott Mabin - [Github](https://github.com/mabezdev) 67 | * Oliver Rockstedt - [GitHub](https://github.com/sourcebox) 68 | * Kor Nielsen - [GitHub](https://github.com/korran) 69 | * Christian Amsüss (@chrysn) – [Codeberg](https://codeberg.org/chrysn) | [GitHub](https://github.com/chrysn) 70 | * Román Cárdenas (@romancardenas) - [GitHub](https://github.com/romancardenas) 71 | * Ian Rees - [GitHub](https://github.com/ianrrees/) 72 | 73 | [OSI]: https://en.wikipedia.org/wiki/Open_Source_Initiative 74 | [REWG]: https://github.com/rust-embedded 75 | [REC]: https://github.com/rust-embedded-community 76 | [rust]: https://www.rust-lang.org 77 | --------------------------------------------------------------------------------