docs: complete macOS node-gyp troubleshooting steps in CONTRIBUTING.md #4036
Conversation
davidmurdoch
changed the title
davidmurdoch
changed the title
CONTRIBUTING.md
Outdated
| @@ -31,7 +31,14 @@ If installation fails due to a `node-gyp` issue you may need to perform some add | |||
|
|
|||
| ### on macOS | |||
|
|
|||
| - I have no idea. | |||
| - Determine if you have Xcode command line tools installed | |||
| - example the console will tell you if they're already installed): `xcode-select --install` | |||
There was a problem hiding this comment.
Can you make the steps more prescriptive? i.e., tell the user what to do directly.
There was a problem hiding this comment.
This style (minus the missing "(") matches the other instructions. Would you like me to modify those too? They're short so it wouldn't take long.
CONTRIBUTING.md
Outdated
| - example: `xcode-select --install` | ||
| - Determine if you have Python 2.x installed | ||
| - example: `which python` | ||
| - If you do not have Python 2.x installed, you need to install it. We recommend `pyenv` for this so you can keep the default MacOS python installation untouched. |
There was a problem hiding this comment.
I don't know Python things... but does this need to be Python 2.7.x?
There was a problem hiding this comment.
which python won't necessarily tell you which version is installed (for example, if you use pyenv, it'll just show you the shim).
python --version is probably more useful.
CONTRIBUTING.md
Outdated
| - example: `xcode-select --install` | ||
| - Determine if you have Python 2.x installed | ||
| - example: `which python` | ||
| - If you do not have Python 2.x installed, you need to install it. We recommend `pyenv` for this so you can keep the default MacOS python installation untouched. |
There was a problem hiding this comment.
which python won't necessarily tell you which version is installed (for example, if you use pyenv, it'll just show you the shim).
python --version is probably more useful.
Deploying with
|
| Latest commit: |
ac8af96
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://36222ead.ganache.pages.dev |
| Branch Preview URL: | https://ngyp-macos-troubleshooting.ganache.pages.dev |
Co-authored-by: David Murdoch <187813+davidmurdoch@users.noreply.github.com>
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2023 Ganache Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
@MicaiahReid <3 |
Does what it says on the tin.