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 #33

Closed
wants to merge 2 commits into from
Closed

Conversation

mabelzhang
Copy link
Contributor

@mabelzhang mabelzhang commented Dec 24, 2020

Partially addresses gazebosim/docs#117

Made headings and code blocks consistent with other per-package installation tutorials.

Signed-off-by: Mabel Zhang <[email protected]>
@codecov
Copy link

codecov bot commented Dec 24, 2020

Codecov Report

Merging #33 (b5b4d3f) into main (a700c15) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main       #33   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines          554       554           
=========================================
  Hits           554       554           

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 a700c15...b5b4d3f. Read the comment docs.

Signed-off-by: Mabel Zhang <[email protected]>
@chapulina chapulina added documentation Improvements or additions to documentation Windows Windows support labels Dec 28, 2020
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.

This is a general comment moreso about all of the build/installation tutorials.

I noticed there's less consistency among all of these (ie, ign transport tutorials are organized by binary and source and then subdivided into the OS, ign msgs tutorials have UNIX vs. Windows as opposed to explicitly listing Ubuntu vs macOS vs Windows and also have a Dependencies and Installation section, etc.). I feel like while we're here we should probably establish a unified format and update all of the installation tutorials to abide by it.

I think I personally like sorting by OS and then under the OS have the type of desired installation, but honestly don't think there's a tremendous difference.

@mabelzhang
Copy link
Contributor Author

mabelzhang commented Jan 14, 2021

Closing in favor of #34
Standardized format there. (Edit: looks like I have something from before to copy-paste for the nesting requested. No guarantee about other libs before this one though. I've been committing a ton of nits to all the previous PRs to keep things consistent. I'm not confident things will remain consistent after 6 months 😅 )

@mabelzhang mabelzhang closed this Jan 14, 2021
@mabelzhang mabelzhang deleted the mabelzhang/windows_install branch January 14, 2021 09:11
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 Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants