Updated readme for PyPa

story645 · web-flow · commit e68e3623eee0 · 2020-03-02T00:08:54.000-05:00
* Updated language to match copy on https://matplotlib.org/devdocs/ * Added logo + front page images * removed link to developer notes since ended up not using that * removed link to gitwash generated docs since they're not very good * used python -mpytest language since it's more robust * updated testing link and shortened to one option * moved contact down 'cause on pypa that information is in the sidebar & for other folks reading the readme they're probably looking for contributions
diff --git a/README.rst b/README.rst
@@ -40,50 +40,45 @@
 .. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
 .. _NUMFocus: http://www.numfocus.org
 
+.. image:: doc/_static/logo2.png
 
-.... image:: doc/_static/logo2.svg
+Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python. 
 
-##########
-Matplotlib
-##########
-Matplotlib is a comprehensive library for creating static, animated, 
-and interactive visualizations in Python.
+Check out our `home page <http://matplotlib.org/>`_ for more information. 
 
+.. image:: doc/_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.
 
-NOTE: The current master branch is now Python 3 only.  Python 2 support is
-being dropped.
-
-`Home page <http://matplotlib.org/>`_
+**Note:** The master branch is Python 3 only.  Python 2 support is being dropped.
 
 Install
 =======
 
-For installation instructions and requirements, see the INSTALL.rst file or the
-`install <http://matplotlib.org/users/installing.html>`_ documentation. If you
-think you may want to contribute to matplotlib, check out the `guide to
-working with the source code
-<http://matplotlib.org/devel/gitwash/index.html>`_.
+For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_  or the
+`install <http://matplotlib.org/users/installing.html>`_ documentation. 
 
 Test
 ====
 
-After installation, you can launch the test suite::
+After installation, launch the test suite::
 
-  pytest
+  python -mpytest
 
-Or from the Python interpreter::
+Read the `testing guide <https://matplotlib.org/devel/testing.html>`_ for more information and alternatives.  
 
-  import matplotlib
-  matplotlib.test()
+Contribute
+==========
+You've discovered a bug or something else you want to change - excellent!
 
-Consider reading http://matplotlib.org/devel/coding_guide.html#testing for more
-information. Note that the test suite requires pytest. Please install with pip
-or your package manager of choice.
+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 <http://matplotlib.org/devdocs/devel/contributing.html>`_!
 
 Contact
 =======
@@ -95,24 +90,13 @@ Our active mailing lists (which are mirrored on Discourse) are:
 * `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_ is for coordinating development and asking questions directly related
 to contributing to matplotlib.
 
-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 <http://matplotlib.org/devdocs/devel/contributing.html>`_!
-
-Developer notes are now at `Developer Discussions <https://github.com/orgs/matplotlib/teams/developers/discussions>`_ (Note: For technical reasons, this is currently only accessible for matplotlib developers.)
 
 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.
