From fc85f5eb6c70e5c868657c8eabc58c933c2d4476 Mon Sep 17 00:00:00 2001 From: Karan Date: Sun, 2 Oct 2022 00:42:54 +0530 Subject: [PATCH 1/3] README.rst to README.md --- README.md | 89 ++++++++++++++++++++++++++++++++++++++++ README.rst | 117 ----------------------------------------------------- 2 files changed, 89 insertions(+), 117 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 000000000000..1944f3d0cabc --- /dev/null +++ b/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: +- [Announcement](https://mail.python.org/mailman/listinfo/matplotlib-announce) + mailing list: +- [Development](https://mail.python.org/mailman/listinfo/matplotlib-devel) + mailing list: + +[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). diff --git a/README.rst b/README.rst deleted file mode 100644 index 7b476c2dacf5..000000000000 --- a/README.rst +++ /dev/null @@ -1,117 +0,0 @@ -|PyPi|_ |Downloads|_ |NUMFocus|_ - -|DiscourseBadge|_ |Gitter|_ |GitHubIssues|_ |GitTutorial|_ - -|GitHubActions|_ |AzurePipelines|_ |AppVeyor|_ |Codecov|_ |LGTM|_ - -.. |GitHubActions| image:: https://github.com/matplotlib/matplotlib/workflows/Tests/badge.svg -.. _GitHubActions: https://github.com/matplotlib/matplotlib/actions?query=workflow%3ATests - -.. |AzurePipelines| image:: https://dev.azure.com/matplotlib/matplotlib/_apis/build/status/matplotlib.matplotlib?branchName=main -.. _AzurePipelines: https://dev.azure.com/matplotlib/matplotlib/_build/latest?definitionId=1&branchName=main - -.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/matplotlib/matplotlib?branch=main&svg=true -.. _AppVeyor: https://ci.appveyor.com/project/matplotlib/matplotlib - -.. |Codecov| image:: https://codecov.io/github/matplotlib/matplotlib/badge.svg?branch=main&service=github -.. _Codecov: https://codecov.io/github/matplotlib/matplotlib?branch=main - -.. |LGTM| image:: https://img.shields.io/lgtm/grade/python/github/matplotlib/matplotlib.svg?logo=lgtm&logoWidth=18 -.. _LGTM: https://lgtm.com/projects/g/matplotlib/matplotlib - -.. |DiscourseBadge| image:: https://img.shields.io/badge/help_forum-discourse-blue.svg -.. _DiscourseBadge: https://discourse.matplotlib.org - -.. |Gitter| image:: https://badges.gitter.im/matplotlib/matplotlib.svg -.. _Gitter: https://gitter.im/matplotlib/matplotlib - -.. |GitHubIssues| image:: https://img.shields.io/badge/issue_tracking-github-blue.svg -.. _GitHubIssues: https://github.com/matplotlib/matplotlib/issues - -.. |GitTutorial| image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg? -.. _GitTutorial: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project - -.. |PyPi| image:: https://badge.fury.io/py/matplotlib.svg -.. _PyPi: https://badge.fury.io/py/matplotlib - -.. |Downloads| image:: https://pepy.tech/badge/matplotlib/month -.. _Downloads: https://pepy.tech/project/matplotlib - -.. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A -.. _NUMFocus: https://numfocus.org - -.. 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 `_ 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 -`_, 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 -`_! - -Contact -======= - -`Discourse `_ 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 `_ mailing - list: matplotlib-users@python.org -* `Announcement - `_ mailing - list: matplotlib-announce@python.org -* `Development `_ - mailing list: matplotlib-devel@python.org - -Gitter_ 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 `_ 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 -`__ or download the -`participant information sheet -`__. From 94c2c593c8b1dee1310cd5f7d218776b7aad8d51 Mon Sep 17 00:00:00 2001 From: Karan Date: Mon, 3 Oct 2022 01:45:07 +0530 Subject: [PATCH 2/3] .rst to .md for README --- README.md | 16 ++++++++-------- setup.py | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1944f3d0cabc..33b31c112f0b 100644 --- a/README.md +++ b/README.md @@ -27,25 +27,25 @@ 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** +## Install See the [install documentation](https://matplotlib.org/stable/users/installing/index.html), which is generated from `/doc/users/installing/index.rst` -## **Contribute** +## Contribute -You\'ve discovered a bug or something else you want to change - +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'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** +## Contact [Discourse](https://discourse.matplotlib.org/) is the discussion forum for general questions and discussions and our recommended starting @@ -64,7 +64,7 @@ Our active mailing lists (which are mirrored on Discourse) are: development and asking questions directly related to contributing to matplotlib. -## **Citing Matplotlib** +## Citing Matplotlib If Matplotlib contributes to a project that leads to publication, please acknowledge this by citing Matplotlib. @@ -73,7 +73,7 @@ acknowledge this by citing Matplotlib. entry](https://matplotlib.org/stable/users/project/citing.html) is available. -### **Research notice** +### Research notice Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this @@ -86,4 +86,4 @@ 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). +sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf). \ No newline at end of file diff --git a/setup.py b/setup.py index d1f1de7078ff..4cd0e109e637 100644 --- a/setup.py +++ b/setup.py @@ -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=[ From 4526fd0610d806e62a355b9cba1a3e17aa62ebe4 Mon Sep 17 00:00:00 2001 From: Karan Date: Mon, 3 Oct 2022 01:51:23 +0530 Subject: [PATCH 3/3] .rst to .md README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33b31c112f0b..d58c26ffcd22 100644 --- a/README.md +++ b/README.md @@ -86,4 +86,4 @@ 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). \ No newline at end of file +sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).