RIOT-OS
README.md: improve feature list
Contribution description
Inspired by comments in #21052 especially https://github.com/RIOT-OS/RIOT/pull/21052#discussion_r1863848019 this tries to improve Riots Feature List
Testing procedure
read kfessel:p-improve-feature-list
Issues/PRs references
#21052 at the same time ( for future reference) #21061 #21063
just to ensure that we are all on the same page: we do want a README that is not concise, and we want to present a long list of features in the README before talking about how to get started and get involved with RIOT?
I see the problem with sprawling Readme files, but I think this is not the case here yet. Structure helps and this PR improves on that.
Related Projects should be moved further down though.
Related Projects should be moved further down though.
even though this was kicked off in that "Related Projects"-PR. I would like to keep this topic out of this PR there are other current PR that target this -- so please keep this out
I see the problem with sprawling Readme files, but I think this is not the case here yet. Structure helps and this PR improves on that.
I already posted that in Matrix but it actually belongs here: I agree with @waehlisch here: I would keep the README concise rather than comprehensive. If someone is looking for a certain feature they would rather look at the documentation (the README may provide a pointer to this list, though). The README should give the reader an idea about which type of features are supported (as in "These are the kind of features RIOT support"). E.g., I consider it important information that RIOT supports TCP/IP plus some application layer protocols but I wouldn't go much more into the details here.
And yes, I know that this post somewhat contradicts my previous comments. ;-)
resolved some conversation (mostly just accepting)
i still think this adds nice structure -- but I also see that this adds noise
even though all these are features some off them are probably less finished (GNSS, PSA and TCP) or less noteworthy (everyone claims flexible memory management)
shall some be removed?
and lets not forget to look at how github renders this and not only on the amount of red and green lines read kfessel:p-improve-feature-list:README.md
Murdock results
:heavy_check_mark: PASSED
3e6145b1da3868a59cc243d350d3954054a42790 README.md: improve feature list
| Success | Failures | Total | Runtime |
|---|---|---|---|
| 1 | 0 | 1 | 02m:04s |
