readme: modernize getting started section#21654
Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom Aug 12, 2025
Merged
Conversation
crasbe
added
Type: enhancement
maribu
approved these changes
Aug 10, 2025
maribu
added
the
Process: needs >1 ACK
github-actions
bot
added
the
Process: missing approvals
AnnsAnns
force-pushed
the
readme_getting_started
branch
from
dbf5b13 to
fb6f721
Compare
Member
Author
|
Squashed 👍 |
crasbe
reviewed
Aug 12, 2025
crasbe
removed
Process: missing approvals
mguetschow
approved these changes
Aug 12, 2025
AnnsAnns
force-pushed
the
readme_getting_started
branch
from
6c66b5a to
b8a723d
Compare
Member
Author
|
The squashing has occurred 🏰 🐉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribution description
The current getting started section is outdated and also contains a few deadlinks to the WSL guide (and technically to the doxygen guide which is completely deprecated)
I simply updated the content to point towards the getting started guide and also mention the Riot Course since that felt quite fair when we already mention the tutorials. I also removed the specific Windows mention since that is already covered within the guide itself.
Lastly I moved the getting started guide above the cloning section. Arguably I'd advocate for removing the cloning section since every getting started guide we have covers it and also have their own requirements where RIOT should be cloned and it only confuses new users while experienced users wouldn't look at it (or simply look at the getting started guides) but this felt like something thats outside of the scope of this PR.
Testing procedure
... Click on the links? 😅
Issues/PRs references