Skip to content
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

Improve installation instructions (backport #1490) #1496

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Nov 5, 2024

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


This is an automatic backport of pull request #1490 done by [Mergify](https://mergify.com).

* 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 <[email protected]>
(cherry picked from commit 22684cb)

# Conflicts:
#	README.md
@mergify mergify bot requested review from azeey and scpeters as code owners November 5, 2024 23:36
@mergify mergify bot added the conflicts label Nov 5, 2024
Copy link
Contributor Author

mergify bot commented Nov 5, 2024

Cherry-pick of 22684cb has failed:

On branch mergify/bp/sdf14/pr-1490
Your branch is up to date with 'origin/sdf14'.

You are currently cherry-picking commit 22684cbe.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot mentioned this pull request Nov 5, 2024
8 tasks
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Nov 5, 2024
Signed-off-by: Steve Peters <[email protected]>
@scpeters scpeters merged commit dcd3cd6 into sdf14 Nov 6, 2024
12 checks passed
@scpeters scpeters deleted the mergify/bp/sdf14/pr-1490 branch November 6, 2024 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant