-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/getting-started: point out where to run make #20336
Merged
benpicco
merged 2 commits into
RIOT-OS:master
from
maribu:doc/doxygen/src/getting-started.md
Feb 5, 2024
Merged
doc/getting-started: point out where to run make #20336
benpicco
merged 2 commits into
RIOT-OS:master
from
maribu:doc/doxygen/src/getting-started.md
Feb 5, 2024
Conversation
This file contains 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
When running `make` in the root directory, it might be best to just add as tl;dr section at the bottom.
maribu
added
Type: bug
The issue reports a bug / The PR fixes a bug (including spelling errors)
Impact: minor
The PR is small in size and might only require a quick look of a knowledgeable reviewer
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
CI: skip compile test
If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
Area: doc
Area: Documentation
and removed
Area: doc
Area: Documentation
labels
Feb 4, 2024
@MrKevinWeiss Do you want a backport? I think the chances of breaking stuff are pretty low with this one :) |
benpicco
approved these changes
Feb 4, 2024
Only minor changes indeed, nothing controversial. |
maribu
changed the title
Doc/doxygen/src/getting started.md
doc/getting-started: point out where to run make
Feb 4, 2024
It is nice but I don't think critical for this release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Area: doc
Area: Documentation
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
CI: skip compile test
If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
Impact: minor
The PR is small in size and might only require a quick look of a knowledgeable reviewer
Type: bug
The issue reports a bug / The PR fixes a bug (including spelling errors)
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
This improves documentation at two locations:
make
is supposed to be run in an applications foldermake
in the root directory got atl'dr
section at the endTesting procedure
make
in the root directory of the repo. The output should be:Issues/PRs references
Fixes #20322 (comment)