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

Add windows installation; move installation in README to tutorial #122

Closed
wants to merge 2 commits into from

Conversation

mabelzhang
Copy link
Contributor

Partially addresses gazebosim/docs#117 and gazebosim/docs#14 (comment) .

TODO: The installation URL in README currently links to ign-msgs tutorials main page, since the installation tutorial webpage doesn't exist yet. Somebody should change the link after this PR is deployed. Trivial fix.

Signed-off-by: Mabel Zhang <[email protected]>
@github-actions github-actions bot added 🏢 edifice Ignition Edifice 🔮 dome Ignition Dome labels Dec 24, 2020
@mabelzhang mabelzhang added the Windows Windows support label Dec 24, 2020
@mabelzhang mabelzhang changed the title Add windows installation Add windows installation; move installation in README to tutorial Dec 24, 2020
@codecov
Copy link

codecov bot commented Dec 24, 2020

Codecov Report

Merging #122 (bde8e44) into ign-msgs6 (4779ef5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           ign-msgs6     #122   +/-   ##
==========================================
  Coverage      84.59%   84.59%           
==========================================
  Files              7        7           
  Lines            818      818           
==========================================
  Hits             692      692           
  Misses           126      126           

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 4779ef5...bde8e44. Read the comment docs.

Signed-off-by: Mabel Zhang <[email protected]>
@chapulina chapulina added the documentation Improvements or additions to documentation label Dec 28, 2020

## Windows

First, follow the [ign-cmake](https://github.com/ignitionrobotics/ign-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and creating a Conda environment.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we point to the tutorial instead?

Copy link
Contributor Author

@mabelzhang mabelzhang Jan 14, 2021

Choose a reason for hiding this comment

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

So... ign-cmake doesn't currently have any tutorials deployed. It was recently added to deploy them, but those pages don't exist yet. I could link to the source of the tutorial, like https://github.com/ignitionrobotics/ign-cmake/blob/ign-cmake2/tutorials/install.md .

Either way, the URL is version-specific, e.g. ign-cmake2, and that means someone will have to update all the tutorials (this wording is the same for each ignition library's tutorial) for each new release. It would also be a different link depending on whether they want ign-cmake2, or ign-cmake3, etc. So I just opted to give the generic link and let them find the right version to look for the tutorial.

Copy link
Collaborator

@caguero caguero left a comment

Choose a reason for hiding this comment

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

Just a minor comment, other than that, it looks good to me.

Copy link

@JShep1 JShep1 left a comment

Choose a reason for hiding this comment

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

LGTM - should we add instructions for install from binary for Windows?

@mabelzhang
Copy link
Contributor Author

Closing in favor of #126 for Citadel

@mabelzhang mabelzhang closed this Jan 14, 2021
@mabelzhang mabelzhang deleted the mabelzhang/windows_install branch January 14, 2021 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants