Skip to content

Commit

Permalink
Re-wrap toplevel readme
Browse files Browse the repository at this point in the history
  • Loading branch information
QuLogic committed Sep 30, 2021
1 parent d3b46f2 commit d1a4a11
Showing 1 changed file with 30 additions and 21 deletions.
51 changes: 30 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,23 +42,24 @@

.. image:: https://matplotlib.org/_static/logo2.svg

Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python.
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,
the Python and IPython shell, web application servers, and various
graphical user interface toolkits.
Matplotlib produces publication-quality figures in a variety of hardcopy
formats and interactive environments across platforms. Matplotlib can be used
in Python scripts, the Python and IPython shell, web application servers, and
various graphical user interface toolkits.


Install
=======

For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the
`install <https://matplotlib.org/users/installing.html>`_ documentation.
`install <https://matplotlib.org/stable/users/installing.html>`_ documentation.

Test
====
Expand All @@ -67,28 +68,36 @@ After installation, launch the test suite::

python -m pytest

Read the `testing guide <https://matplotlib.org/devel/testing.html>`_ for more information and alternatives.
Read the `testing guide <https://matplotlib.org/stable/devel/testing.html>`_
for more information and alternatives.

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>`_!
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.
`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: [email protected]
* `Announcement <https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing list: [email protected]
* `Development <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ mailing list: [email protected]
* `Users <https://mail.python.org/mailman/listinfo/matplotlib-users>`_ mailing
list: [email protected]
* `Announcement
<https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing
list: [email protected]
* `Development <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_
mailing list: [email protected]

Gitter_ is for coordinating development and asking questions directly related
to contributing to matplotlib.
Expand All @@ -99,21 +108,21 @@ 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/citing.html>`_ is available.
`A ready-made citation entry <https://matplotlib.org/stable/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.
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.
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>`__.
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>`__.

0 comments on commit d1a4a11

Please sign in to comment.