README is now markdown instead of reStructuredText (#1536)

Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>

6 files changed, 35 insertions, 49 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9ea9db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+![GitHub commits since latest release](https://img.shields.io/github/commits-since/pypa/virtualenv/latest)
+![PyPI](https://img.shields.io/pypi/v/virtualenv?style=flat-square)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/virtualenv?style=flat-square)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/virtualenv?style=flat-square)
+![Documentation](https://readthedocs.org/projects/virtualenv/badge/?version=latest&style=flat-square)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/virtualenv?style=flat-square)
+![PyPI - License](https://img.shields.io/pypi/l/virtualenv?style=flat-square)
+![Azure DevOps builds](https://img.shields.io/azure-devops/build/pypa/virtualenv/11?style=flat-square)
+![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/pypa/virtualenv/11?style=flat-square)
+[![Code style:
+black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+virtualenv
+==========
+
+A tool for creating isolated ``virtual`` python environments.
+
+- [Installation](https://virtualenv.pypa.io/en/latest/installation.html)
+- [Documentation](https://virtualenv.pypa.io)
+- [Changelog](https://virtualenv.pypa.io/en/latest/changes.html)
+- [Issues](https://github.com/pypa/virtualenv/issues)
+- [PyPI](https://pypi.org/project/virtualenv)
+- [Github](https://github.com/pypa/virtualenv)
+
+Code of Conduct
+---------------
+
+Everyone interacting in the virtualenv project's codebases, issue trackers, chat rooms, and mailing lists is expected to
+follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 83aaf2f..0000000
--- a/README.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-virtualenv
-==========
-
-A tool for creating isolated 'virtual' python environments.
-
-.. image:: https://img.shields.io/pypi/v/virtualenv.svg
-  :target: https://pypi.org/project/virtualenv
-  :alt: Latest version on PyPI
-.. image:: https://img.shields.io/pypi/pyversions/virtualenv.svg
-  :target: https://pypi.org/project/virtualenv/
-  :alt: Supported Python versions
-.. image:: https://dev.azure.com/pypa/virtualenv/_apis/build/status/pypa.virtualenv?branchName=master
-  :target: https://dev.azure.com/pypa/virtualenv/_build/latest?definitionId=11&branchName=master
-  :alt: Azure Pipelines build status
-.. image:: https://readthedocs.org/projects/virtualenv/badge/?version=latest&style=flat-square
-  :target: https://virtualenv.readthedocs.io/en/latest/?badge=latest
-  :alt: Documentation status
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-  :target: https://github.com/ambv/black
-  :alt: Code style: black
-.. image:: https://pepy.tech/badge/virtualenv/month
-  :target: https://pepy.tech/project/virtualenv/month
-  :alt: Downloads
-
-* `Installation <https://virtualenv.pypa.io/en/latest/installation.html>`_
-* `Documentation <https://virtualenv.pypa.io/>`_
-* `Changelog <https://virtualenv.pypa.io/en/latest/changes.html>`_
-* `Issues <https://github.com/pypa/virtualenv/issues>`_
-* `PyPI <https://pypi.org/project/virtualenv/>`_
-* `Github <https://github.com/pypa/virtualenv>`_
-* `User mailing list <http://groups.google.com/group/python-virtualenv>`_
-* `Dev mailing list <http://groups.google.com/group/pypa-dev>`_
-* User IRC: `#pypa on Freenode <https://webchat.freenode.net/?channels=%23pypa>`_
-* Dev IRC: `#pypa-dev on Freenode <https://webchat.freenode.net/?channels=%23pypa-dev>`_
-
-
-Code of Conduct
----------------
-
-Everyone interacting in the virtualenv project's codebases, issue trackers,
-chat rooms, and mailing lists is expected to follow the
-`PyPA Code of Conduct`_.
-
-.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 4280986..63befe3 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -56,7 +56,7 @@ jobs:
         image: [linux, windows]
       docs:
         image: [linux, windows]
-      package_readme:
+      readme:
         image: [linux, windows]
       upgrade:
         image: [linux, windows]
@@ -100,4 +100,4 @@ jobs:
     parameters:
       external_feed: 'gb'
       pypi_remote: 'pypi-gb'
-      dependsOn: [fix_lint, embed, docs, report_coverage, dev, package_readme]
+      dependsOn: [fix_lint, embed, docs, report_coverage, dev, readme]
diff --git a/docs/changelog/1531.doc.rst b/docs/changelog/1531.doc.rst
new file mode 100644
index 0000000..328cd25
--- /dev/null
+++ b/docs/changelog/1531.doc.rst
@@ -0,0 +1 @@
+Project readme is now of type MarkDown instead of reStructuredText - by ``gaborbernat``.
diff --git a/setup.cfg b/setup.cfg
index 64eee49..8e8635a 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -2,8 +2,8 @@
 name = virtualenv
 version = attr: virtualenv.__version__
 description = Virtual Python Environment builder
-long_description = file: README.rst
-long_description_content_type = text/x-rst
+long_description = file: README.md
+long_description_content_type = text/markdown
 url = https://virtualenv.pypa.io/
 author = Bernat Gabor
 license = MIT
diff --git a/tox.ini b/tox.ini
index 96434cf..6619cfe 100644
--- a/tox.ini
+++ b/tox.ini
@@ -76,7 +76,7 @@ commands =
     sphinx-build -d "{envtmpdir}/doctree" -W docs "{toxworkdir}/docs_out" --color -bhtml {posargs}
     python -c 'import pathlib; print("documentation available under file://\{0\}".format(pathlib.Path(r"{toxworkdir}") / "docs_out" / "index.html"))'
 
-[testenv:package_readme]
+[testenv:readme]
 description = check that the long description is valid (need for PyPI)
 deps =
     {[testenv]deps}