DOC: Simplify the Quickstart section in README.md - #4773
Open
seisman wants to merge 1 commit into
Open
Conversation
seisman
added
documentation
seisman
commented
Jul 28, 2026
| conda install --channel conda-forge pygmt | ||
| ``` | ||
|
|
||
| For other ways to install `pygmt`, see the [full installation instructions](https://www.pygmt.org/latest/install.html). |
Member
Author
There was a problem hiding this comment.
Moved to the end so that users are not directed away from the PyGMT documentation too early.
| For other ways to install `pygmt`, see the [full installation instructions](https://www.pygmt.org/latest/install.html). | ||
|
|
||
| ### Getting started | ||
| Then try the following example in a Python interpreter or Jupyter notebook. You should |
Member
Author
There was a problem hiding this comment.
Remove the links to the Python interpreter and Jupyter Notebook, assuming that users already know how to run Python code. Users who do not know how to run Python code are also unlikely to be familiar with conda, so I think this is a reasonable assumption.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Combine the Quickstart content into one single section, and simplify the description.
Address #4746.