Skip to content

Commit 8548731

Browse files
committed
Update with feedback from @therealprof and @japaric
1 parent 4177a15 commit 8548731

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

rfcs/0000-embedded-rust-showcase.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ developers.
2121
The main embedded Rust website will contain a shortlist of especially notable
2222
projects, but is aimed at presenting a very high-level overview to all users
2323
including non-technical users. This proposed list would be able to present more
24-
projects in more detail, and will require that their source code is publically
24+
projects in more detail, and will require that their source code is publicly
2525
available so embedded developers interested in Rust can inspect it.
2626

2727
# Detailed design
@@ -50,20 +50,28 @@ To be considered for inclusion, projects must:
5050

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

53-
* Have publically available source code
53+
* Have publicly available source code
5454

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

6161
* Have working CI builds
6262

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

67+
* Have build instructions
68+
69+
These might be as simple as `cargo build` or might document any specific
70+
Rust versions, build oddities, or other steps required to produce the
71+
final firmware. Projects could also document their physical build, for example
72+
whether a particular development board was used, or what custom hardware is
73+
present, but this is not required.
74+
6775
* Have at least one photograph/video/GIF of the project in action
6876

6977
## Project Submission

0 commit comments

Comments
 (0)