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 Windows Installation instructions #381

Merged
merged 8 commits into from
Sep 19, 2023
Merged

Conversation

peci1
Copy link
Contributor

@peci1 peci1 commented Sep 3, 2023

🎉 New feature

Summary

Going through the Windows install instructions for Harmonic, these are a few changes that will hopefully enable more users to finish the installation.

Test it

Try installing it :-D

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • 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.

Signed-off-by: Martin Pecka <peci1@seznam.cz>

Signed-off-by: Martin Pecka <peci1@seznam.cz>
@peci1 peci1 requested a review from mabelzhang as a code owner September 3, 2023 02:09
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Sep 3, 2023
Signed-off-by: Martin Pecka <peci1@seznam.cz>
Copy link
Contributor

@traversaro traversaro left a comment

Choose a reason for hiding this comment

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

Minor comments, thanks for working on this!

harmonic/install_windows_src.md Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
Signed-off-by: Martin Pecka <peci1@seznam.cz>
Signed-off-by: Martin Pecka <peci1@seznam.cz>
@peci1
Copy link
Contributor Author

peci1 commented Sep 15, 2023

All comments should be resolved now.

Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Copy link
Contributor

@mabelzhang mabelzhang left a comment

Choose a reason for hiding this comment

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

Some formatting things.

While we're here, I noticed some indentation mistakes in the original page that existed before this PR, so I pushed ab0cf96 to fix them.

harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
harmonic/install_windows_src.md Outdated Show resolved Hide resolved
@mabelzhang
Copy link
Contributor

mabelzhang commented Sep 16, 2023

This PR should be double-checked by someone on the dev team who's familiar with Windows. There are bits about packaging and rendering. Maybe @j-rivero and/or @iche033?

peci1 and others added 2 commits September 16, 2023 10:17
Co-authored-by: Mabel Zhang <mabel.m.zhang@gmail.com>
Signed-off-by: Martin Pecka <peci1@seznam.cz>
Signed-off-by: Martin Pecka <peci1@seznam.cz>
@peci1
Copy link
Contributor Author

peci1 commented Sep 16, 2023

Thanks for the formatting improvements. I turned all WARNINGs into NOTEs.

@mjcarroll mjcarroll merged commit c6d09bd into gazebosim:master Sep 19, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants