Add instructions to build and run examples#192
Merged
Conversation
Signed-off-by: Louise Poubel <louise@openrobotics.org>
Codecov Report
@@ Coverage Diff @@
## ign-math6 #192 +/- ##
==========================================
Coverage 99.20% 99.20%
==========================================
Files 63 63
Lines 6020 6020
==========================================
Hits 5972 5972
Misses 48 48 Continue to review full report at Codecov.
|
8 tasks
Signed-off-by: Louise Poubel <louise@openrobotics.org>
ahcorde
approved these changes
Feb 15, 2021
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
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.
New feature
Summary
Users may not immediately know how to use the examples. I didn't see any instructions on how to build and run them, so I added a very short README.
Test it
Try following the instructions on the README to see if they work.
Checklist
codecheckpassed (See contributing)another open pull request
to support the maintainers
Note to maintainers: Remember to use Squash-Merge