Skip to content

Add working example to quickstart section of README#2369

Merged
seisman merged 10 commits intomainfrom
add-getting-started
Feb 17, 2023
Merged

Add working example to quickstart section of README#2369
seisman merged 10 commits intomainfrom
add-getting-started

Conversation

@yvonnefroehlich
Copy link
Member

Description of proposed changes

This PR aims to add a simple working example to the Quickstart section in the README file.

Fixes #2364

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@yvonnefroehlich yvonnefroehlich added the enhancement Improving an existing feature label Feb 15, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.9.0 milestone Feb 15, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Feb 15, 2023
@seisman seisman added documentation Improvements or additions to documentation and removed enhancement Improving an existing feature labels Feb 16, 2023
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
yvonnefroehlich and others added 2 commits February 16, 2023 09:13
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich yvonnefroehlich changed the title WIP: Add working example to quickstart section of README Add working example to quickstart section of README Feb 16, 2023
yvonnefroehlich and others added 3 commits February 16, 2023 20:03
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Feb 16, 2023
@seisman seisman merged commit 2ecf8e4 into main Feb 17, 2023
@seisman seisman deleted the add-getting-started branch February 17, 2023 13:08
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants