Skip to content

Add instructions to build and run examples#192

Merged
chapulina merged 2 commits intoign-math6from
chapulina/6/examples
Feb 16, 2021
Merged

Add instructions to build and run examples#192
chapulina merged 2 commits intoign-math6from
chapulina/6/examples

Conversation

@chapulina
Copy link
Copy Markdown
Contributor

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

  • Signed all commits for DCO
  • Added tests
  • Added example world and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review
    another open pull request
    to support the maintainers

Note to maintainers: Remember to use Squash-Merge

Signed-off-by: Louise Poubel <louise@openrobotics.org>
@chapulina chapulina added the documentation Improvements or additions to documentation label Feb 14, 2021
@chapulina chapulina requested a review from scpeters as a code owner February 14, 2021 01:43
@github-actions github-actions bot added 🏢 edifice Ignition Edifice 🏰 citadel Ignition Citadel 📜 blueprint Ignition Blueprint 🔮 dome Ignition Dome labels Feb 14, 2021
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 14, 2021

Codecov Report

Merging #192 (9d486f9) into ign-math6 (5a4321b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5a4321b...9d486f9. Read the comment docs.

Signed-off-by: Louise Poubel <louise@openrobotics.org>
@chapulina chapulina merged commit a6e187a into ign-math6 Feb 16, 2021
@chapulina chapulina deleted the chapulina/6/examples branch February 16, 2021 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants