-
Notifications
You must be signed in to change notification settings - Fork 224
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
Update install.rst #324
Update install.rst #324
Conversation
💖 Thanks for opening this pull request! 💖 Please make sure you read our contributing guidelines and abide by our code of conduct. A few things to keep in mind:
|
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.
Hi @btozer! Thanks for submitting this quick documentation fix. Sorry for all the red warnings about tests failing, it really shouldn't have been doing that. I've restarted the Linux Travis-CI build which passed, but we'll need to wait for one of the other core devs to restart the Mac Azure one.
If you have more time, you could make the example a bit clearer. For example, I found this line in an old pull request at #279 which used
export GMT_LIBRARY_PATH=$HOME/anaconda3/envs/pygmt/lib
Also just a side note that it would be great to give Windows users proper instructions as well, i.e. set the path to the gmt_w64.dll
file, c.f. #285.
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.
Hi again @btozer, I've suggested a few changes that should make it easier for Windows 🏁 users. Feel free to make any other changes as you see fit, but once you're done, click on the 'Update branch' button to bring your patch up to date with the master branch, and this should be ready to merge!
Co-Authored-By: Wei Ji <[email protected]>
Co-Authored-By: Wei Ji <[email protected]>
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.
Yep, looks good!
@seisman could you merge this in? It's saying I'm not authorized to merge into the master branch. |
🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉 Please open a new pull request to add yourself to the |
Description of proposed changes
Include explicit instruction for how to set GMT_LIBRARY_PATH
Fixes #
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.