Skip to content

Commit

Permalink
Merge pull request #24067 from grgkaran03/kg-feature2
Browse files Browse the repository at this point in the history
README.rst to README.md
  • Loading branch information
tacaswell committed Oct 6, 2022
2 parents 884397a + 4526fd0 commit eb44018
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 119 deletions.
89 changes: 89 additions & 0 deletions README.md
@@ -0,0 +1,89 @@
[![PyPi](https://badge.fury.io/py/matplotlib.svg)](https://badge.fury.io/py/matplotlib)
[![Downloads](https://pepy.tech/badge/matplotlib/month)](https://pepy.tech/project/matplotlib)
[![NUMFocus](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)

[![DiscourseBadge](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.matplotlib.org)
[![Gitter](https://badges.gitter.im/matplotlib/matplotlib.svg)](https://gitter.im/matplotlib/matplotlib)
[![GitHubIssues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/matplotlib/matplotlib/issues)
[![GitTutorial](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)

[![GitHubActions](https://github.com/matplotlib/matplotlib/workflows/Tests/badge.svg)](https://github.com/matplotlib/matplotlib/actions?query=workflow%3ATests)
[![AzurePipelines](https://dev.azure.com/matplotlib/matplotlib/_apis/build/status/matplotlib.matplotlib?branchName=main)](https://dev.azure.com/matplotlib/matplotlib/_build/latest?definitionId=1&branchName=main)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/matplotlib/matplotlib?branch=main&svg=true)](https://ci.appveyor.com/project/matplotlib/matplotlib)
[![Codecov](https://codecov.io/github/matplotlib/matplotlib/badge.svg?branch=main&service=github)](https://codecov.io/github/matplotlib/matplotlib?branch=main)
[![LGTM](https://img.shields.io/lgtm/grade/python/github/matplotlib/matplotlib.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/matplotlib/matplotlib)

![image](https://matplotlib.org/_static/logo2.svg)

Matplotlib is a comprehensive library for creating static, animated, and
interactive visualizations in Python.

Check out our [home page](https://matplotlib.org/) for more information.

![image](https://matplotlib.org/_static/readme_preview.png)

Matplotlib produces publication-quality figures in a variety of hardcopy
formats and interactive environments across platforms. Matplotlib can be
used in Python scripts, Python/IPython shells, web application servers,
and various graphical user interface toolkits.

## Install

See the [install
documentation](https://matplotlib.org/stable/users/installing/index.html),
which is generated from `/doc/users/installing/index.rst`

## Contribute

You've discovered a bug or something else you want to change -
excellent!

You've worked out a way to fix it -- even better!

You want to tell us about it -- best of all!

Start at the [contributing
guide](https://matplotlib.org/devdocs/devel/contributing.html)!

## Contact

[Discourse](https://discourse.matplotlib.org/) is the discussion forum
for general questions and discussions and our recommended starting
point.

Our active mailing lists (which are mirrored on Discourse) are:

- [Users](https://mail.python.org/mailman/listinfo/matplotlib-users)
mailing list: <matplotlib-users@python.org>
- [Announcement](https://mail.python.org/mailman/listinfo/matplotlib-announce)
mailing list: <matplotlib-announce@python.org>
- [Development](https://mail.python.org/mailman/listinfo/matplotlib-devel)
mailing list: <matplotlib-devel@python.org>

[Gitter](https://gitter.im/matplotlib/matplotlib) is for coordinating
development and asking questions directly related to contributing to
matplotlib.

## Citing Matplotlib

If Matplotlib contributes to a project that leads to publication, please
acknowledge this by citing Matplotlib.

[A ready-made citation
entry](https://matplotlib.org/stable/users/project/citing.html) is
available.

### Research notice

Please note that this repository is participating in a study into
sustainability of open source projects. Data will be gathered about this
repository for approximately the next 12 months, starting from June
2021.

Data collected will include number of contributors, number of PRs, time
taken to close/merge these PRs, and issues closed.

For more information, please visit [the informational
page](https://sustainable-open-science-and-software.github.io/) or
download the [participant information
sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).
117 changes: 0 additions & 117 deletions README.rst

This file was deleted.

4 changes: 2 additions & 2 deletions setup.py
Expand Up @@ -271,8 +271,8 @@ def make_release_tree(self, base_dir, files):
'Forum': 'https://discourse.matplotlib.org/',
'Donate': 'https://numfocus.org/donate-to-matplotlib'
},
long_description=Path("README.rst").read_text(encoding="utf-8"),
long_description_content_type="text/x-rst",
long_description=Path("README.md").read_text(encoding="utf-8"),
long_description_content_type="text/markdown",
license="PSF",
platforms="any",
classifiers=[
Expand Down

0 comments on commit eb44018

Please sign in to comment.