-
Notifications
You must be signed in to change notification settings - Fork 45
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
Conversation
Signed-off-by: Mabel Zhang <[email protected]>
Codecov Report
@@ 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.
|
Signed-off-by: Mabel Zhang <[email protected]>
|
||
## 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
There was a problem hiding this 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?
Closing in favor of #126 for Citadel |
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.