Skip to content

Commit

Permalink
Update with feedback from @therealprof and @japaric
Browse files Browse the repository at this point in the history
  • Loading branch information
adamgreig committed Aug 22, 2018
1 parent 4177a15 commit 8548731
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions rfcs/0000-embedded-rust-showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ developers.
The main embedded Rust website will contain a shortlist of especially notable
projects, but is aimed at presenting a very high-level overview to all users
including non-technical users. This proposed list would be able to present more
projects in more detail, and will require that their source code is publically
projects in more detail, and will require that their source code is publicly
available so embedded developers interested in Rust can inspect it.

# Detailed design
Expand Down Expand Up @@ -50,20 +50,28 @@ To be considered for inclusion, projects must:

* Involve embedded Rust, in other words, use Rust and run on embedded hardware

* Have publically available source code
* Have publicly available source code

The objective of this list is to showcase Rust code in action; we can't do this
if people can't read the code! There might be space on the main Embedded Rust
website to showcase projects known to use Rust but without public code. We
don't require that the source code is under an open source license; just that
it's available for interested users to read.
don't require any specific license; just that it's available for interested
users to read.

* Have working CI builds

Since we want people to be able to learn from the code, we require it at least
builds successfully. Working CI also shows what versions of Rust it builds on,
which is useful to establish if a project works on stable Rust.

* Have build instructions

These might be as simple as `cargo build` or might document any specific
Rust versions, build oddities, or other steps required to produce the
final firmware. Projects could also document their physical build, for example
whether a particular development board was used, or what custom hardware is
present, but this is not required.

* Have at least one photograph/video/GIF of the project in action

## Project Submission
Expand Down

0 comments on commit 8548731

Please sign in to comment.