Missing instructions on Windows Mingw INSTALL.md
Open
Nobody has claimed this yet.
A-docs
C-discussion
O-windows
T-bootstrap
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Location
The INSTALL.md instructions for Windows does not advise to add the Mingw bin folder in the PATH. In this case it can save a lot of trouble by only adding a single line like it follows:
MinGW
MSYS2 can be used to easily build Rust on Windows:
- Download the latest MSYS2 installer and go through the installer. Make sure to add the 'msys64\mingw64\bin' folder to your PATH
Summary
Very simple change but can save time to new developers.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open INSTALL.md and locate the Windows MinGW setup instructions. Check how the MSYS2 paths are described, then update the instructions so the required mingw64/bin PATH addition is explicit; done means a new Windows developer can find and follow that step without guessing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100