-
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: Add out of tree RIOT app documentation #19324
Merged
Merged
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
bergzand
force-pushed
the
pr/doc-out-of-tree
branch
from
February 27, 2023 12:44
67c85b2
to
623ec02
Compare
maribu
reviewed
Feb 27, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm. Some suggestions inline
aabadie
reviewed
Feb 27, 2023
maribu
reviewed
Feb 27, 2023
maribu
approved these changes
Feb 27, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
bergzand
force-pushed
the
pr/doc-out-of-tree
branch
from
February 27, 2023 13:48
945a7a7
to
68bc404
Compare
Squashed! |
bergzand
added
the
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
label
Feb 27, 2023
benpicco
added
the
CI: skip compile test
If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
label
Feb 27, 2023
bors merge |
Build succeeded: |
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
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 PR adds documentation on how to create an out-of-tree RIOT application using a directory structure I've personally been using for a few projects.
Testing procedure
Check the new documentation and try to determine whether it is sufficient and clear enough to get somewhat new users up to speed
Issues/PRs references
The occasional forum post and Matrix question on how to achieve this