Merge pull request #3351 from jlaehne/readme

Readme to markdown

README.md

@@ -0,0 +1,42 @@
+
+[![Azure pipelines status](https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_apis/build/status/hyperspy.hyperspy?branchName=RELEASE_next_minor)](https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_build?definitionId=1&_a=summary&view=branches)
+[![Tests status](https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml/badge.svg)](https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml)
+[![Documentation status](https://readthedocs.org/projects/hyperspy/badge/?version=latest)](https://hyperspy.org/hyperspy-doc/current)
+[![Codecov coverage](https://codecov.io/gh/hyperspy/hyperspy/graph/badge.svg?token=X7T3LE121Q)](https://codecov.io/gh/hyperspy/hyperspy)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/hyperspy/hyperspy/RELEASE_next_minor.svg)](https://results.pre-commit.ci/latest/github/hyperspy/hyperspy/RELEASE_next_minor)
+
+[![Python Version](https://img.shields.io/pypi/pyversions/hyperspy.svg?style=flat)](https://pypi.python.org/pypi/hyperspy)
+[![PyPI Version](http://img.shields.io/pypi/v/hyperspy.svg?style=flat)](https://pypi.python.org/pypi/hyperspy)
+[![Anaconda Version](https://anaconda.org/conda-forge/hyperspy/badges/version.svg)](https://anaconda.org/conda-forge/hyperspy)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+[![gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hyperspy/hyperspy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![DOI](https://zenodo.org/badge/2233998.svg)](https://zenodo.org/badge/latestdoi/2233998)
+
+
+**HyperSpy** is an open source Python library for the interactive analysis of
+multidimensional datasets that can be described as multidimensional arrays
+of a given signal (for example, a 2D array of spectra, also known as a
+spectrum image).
+
+**HyperSpy** makes it straightforward to apply analytical procedures that
+operate on an individual signal to multidimensional arrays, as well as
+providing easy access to analytical tools that exploit the multidimensionality
+of the dataset.
+
+Its modular structure makes it easy to add features to analyze many different
+types of signals. Visit the [HyperSpy Website](https://hyperspy.org) to learn more about HyperSpy and
+its extension packages and for instructions on how to install the package and get
+started in analysing your data.
+
+HyperSpy is released under the GPL v3 license.
+
+**Since version 0.8.4, HyperSpy only supports Python 3.** If you need to install
+HyperSpy in Python 2.7, please install version 0.8.3.
+
+Contributing
+------------
+
+Everyone is welcome to contribute. Please read our [contributing 
+guidelines](https://github.com/hyperspy/hyperspy/blob/RELEASE_next_minor/.github/CONTRIBUTING.md) 
+and get started!

pyproject.toml

@@ -82,7 +82,7 @@ keywords = [
     "spectrum image",
 ]
 name = "hyperspy"
-readme = "README.rst"
+readme = "README.md"
 requires-python = ">=3.8"
 
 [project.license]

upcoming_changes/3351.maintenance.rst

@@ -0,0 +1 @@
+Convert projet readme to markdown, fixes badges on github