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

Improve installation instructions #1490

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

scpeters
Copy link
Member

🦟 Bug fix

Improves installation instructions in README

Summary

  • Refer to https://brew.sh/ instead of duplicating the brew installation command.
  • List cmake variables in a markdown table.
  • Combine Ubuntu and macOS build-from-source instructions (85e5067)

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • 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 and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

* Refer to https://brew.sh instead of duplicating the
  brew installation command.
* List cmake variables in a markdown table.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters scpeters requested a review from azeey as a code owner October 15, 2024 12:00
@github-actions github-actions bot added the 🏛️ ionic Gazebo Ionic label Oct 15, 2024
@scpeters scpeters merged commit 22684cb into sdf15 Oct 29, 2024
13 checks passed
@scpeters scpeters deleted the scpeters/improve_installation_instructions branch October 29, 2024 17:13
@scpeters
Copy link
Member Author

scpeters commented Nov 5, 2024

https://github.com/Mergifyio backport sdf14

Copy link
Contributor

mergify bot commented Nov 5, 2024

backport sdf14

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 5, 2024
* Refer to https://brew.sh instead of duplicating the
  brew installation command.
* List cmake variables in a markdown table.
* Combine Ubuntu and macOS installation instructions

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
(cherry picked from commit 22684cb)

# Conflicts:
#	README.md
scpeters added a commit that referenced this pull request Nov 6, 2024
Backport of #1490.

* Refer to https://brew.sh instead of duplicating the
  brew installation command.
* List cmake variables in a markdown table.
* Combine Ubuntu and macOS installation instructions

(cherry picked from commit 22684cb)

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Co-authored-by: Steve Peters <scpeters@openrobotics.org>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
🏛️ ionic Gazebo Ionic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants