@@ -21,7 +21,7 @@ developers.
21
21
The main embedded Rust website will contain a shortlist of especially notable
22
22
projects, but is aimed at presenting a very high-level overview to all users
23
23
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
25
25
available so embedded developers interested in Rust can inspect it.
26
26
27
27
# Detailed design
@@ -50,20 +50,28 @@ To be considered for inclusion, projects must:
50
50
51
51
* Involve embedded Rust, in other words, use Rust and run on embedded hardware
52
52
53
- * Have publically available source code
53
+ * Have publicly available source code
54
54
55
55
The objective of this list is to showcase Rust code in action; we can't do this
56
56
if people can't read the code! There might be space on the main Embedded Rust
57
57
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.
60
60
61
61
* Have working CI builds
62
62
63
63
Since we want people to be able to learn from the code, we require it at least
64
64
builds successfully. Working CI also shows what versions of Rust it builds on,
65
65
which is useful to establish if a project works on stable Rust.
66
66
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
+
67
75
* Have at least one photograph/video/GIF of the project in action
68
76
69
77
## Project Submission
0 commit comments