Skip to content

Update README.md #28042

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

Merged
merged 3 commits into from
Aug 29, 2015
Merged

Update README.md #28042

merged 3 commits into from
Aug 29, 2015

Conversation

Jake-Shadle
Copy link
Contributor

Encountered an issue with pacman while going through the guide for installing the mingw toolchain on Windows with msys2, after some googling I found the solution.

I thought it would be good to update the README so people don't get frustrated. 😃

r? @steveklabnik

Encountered an issue going through the guide for installing the `mingw` toolchain on Windows with msys2, after some googling I found the [solution](msys2/MSYS2-packages#163 (comment)) and thought it would be good to update the README so people don't get frustrated. :)
@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@steveklabnik
Copy link
Member

Hey @Jake-Shadle ! While this might be helpful, I'm also not sure we want to be including Pacman help in our README.

@brson has kind of been the "Guardian of the README" lately. Brian, what do you think?

@Jake-Shadle
Copy link
Contributor Author

Cluttering the README might be bad, but as far as I can tell, any Windows user who tried the current README would fail on that step, which isn't a great user experience. Maybe just a link to the issue mentioned in this PR would suffice? eg.

_Note:_ If you have problems installing the toolchain, see here

@brson
Copy link
Contributor

brson commented Aug 27, 2015

@Jake-Shadle what would you think of simply adding the update command as the first step, so assume they are going to have the correct packages and not run into this error? Like

# Update package list
$ pacman -Sy && pacman -S pacman-mirrors

# Choose one based on platform:
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain

$ pacman -S base-devel

@jonas-schievink
Copy link
Contributor

@brson I think you can just do pacman -Sy pacman-mirrors

Folded in suggestion from @brson to simply put the mirror update step in the regular set of tool chain install commands.
@Jake-Shadle
Copy link
Contributor Author

@brson took your suggestion and added the commands with a comment in the existing code block, nice and succinct!

@brson
Copy link
Contributor

brson commented Aug 28, 2015

@Jake-Shadle What do you think of @jonas-schievink's suggestion to just write pacman -Sy pacman-mirrors?

Use suggested composite command instead of 2 separate commands.
@Jake-Shadle
Copy link
Contributor Author

@brson Heh, fair enough, it is the main readme of the language, how is it now?

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 28, 2015

📌 Commit 7ab8ed8 has been approved by steveklabnik

@bors
Copy link
Collaborator

bors commented Aug 29, 2015

⌛ Testing commit 7ab8ed8 with merge d3b367e...

bors added a commit that referenced this pull request Aug 29, 2015
Encountered an issue with `pacman` while going through the guide for installing the `mingw` toolchain on Windows with `msys2`, after some googling I found the [solution](msys2/MSYS2-packages#163 (comment)).

I thought it would be good to update the README so people don't get frustrated. 😃 

r? @steveklabnik
@bors bors merged commit 7ab8ed8 into rust-lang:master Aug 29, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants