Skip to content

Add a quick example in the quickstart section of the README file? #2364

@seisman

Description

@seisman

Currently, the Quickstart section in the README file only have one subsection with quick installation instructions. I think a real quickstart section should also have a simple working example so that users have a quick idea about how PyGMT works. So I propose to add a simple example in the quickstart section, like:

import pygmt
fig = pygmt.Figure()
fig.coast(projection="H10c", region="g", frame=True, land="gray")
fig.show()

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions