Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

doc: Add out of tree RIOT app documentation #19324

Merged
merged 1 commit into from
Feb 27, 2023

Conversation

bergzand
Copy link
Member

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

@bergzand bergzand added the Area: doc Area: Documentation label Feb 27, 2023
@bergzand bergzand requested a review from maribu February 27, 2023 12:35
Copy link
Member

@maribu maribu left a 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

Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@bergzand
Copy link
Member Author

Squashed!

@bergzand 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
@riot-ci
Copy link

riot-ci commented Feb 27, 2023

Murdock results

✔️ PASSED

68bc404 doc: Add out of tree RIOT app documentation

Success Failures Total Runtime
1 0 1 55s

Artifacts

@benpicco 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
@benpicco
Copy link
Contributor

bors merge

@bors
Copy link
Contributor

bors bot commented Feb 27, 2023

Build succeeded:

@bors bors bot merged commit ee7ea44 into RIOT-OS:master Feb 27, 2023
@bergzand bergzand deleted the pr/doc-out-of-tree branch February 27, 2023 15:31
@MrKevinWeiss MrKevinWeiss added this to the Release 2023.04 milestone Apr 25, 2023
# for free to join this conversation on GitHub. Already have an account? # 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants