Merge pull request #486 from hakonanes/update-readme

pyxem · Apr 12, 2024 · 8620292 · 8620292
2 parents 0e0ef33 + 6c8a681
commit 8620292
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 31 deletions.
diff --git a/README.rst b/README.rst
@@ -11,41 +11,72 @@
 .. in the source distributions uploaded to PyPI
 .. EXCLUDE
 
-|binder|_ |build_status|_ |Coveralls|_ |docs|_ |pypi_version|_  |downloads|_ |black|_ |doi|_
+orix is an open-source Python library for analysing orientations and crystal symmetry.
 
-.. |binder| image:: https://mybinder.org/badge_logo.svg
-.. _binder: https://mybinder.org/v2/gh/pyxem/orix/HEAD
+The package defines objects and functions for the analysis of orientations represented
+as quaternions and 3D rotation vectors, accounting for crystal symmetry.
+Functionality builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
+<https://matplotlib.org>`_.
+Initiation of the package was inspired by `MTEX <https://mtex-toolbox.github.io>`_.
+
+orix is released under the GPL v3 license.
+
+.. |pypi_version| image:: https://img.shields.io/pypi/v/orix.svg?style=flat
+   :target: https://pypi.python.org/pypi/orix
+
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/orix.svg?logo=conda-forge&logoColor=white
+   :target: https://anaconda.org/conda-forge/orix
 
 .. |build_status| image:: https://github.com/pyxem/orix/workflows/build/badge.svg
-.. _build_status: https://github.com/pyxem/orix/actions
+   :target: https://github.com/pyxem/orix/actions/workflows/build.yml
+
+.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg
+   :target: https://www.python.org/downloads/
 
 .. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/orix/badge.svg?branch=develop
-.. _Coveralls: https://coveralls.io/github/pyxem/orix?branch=develop
+   :target: https://coveralls.io/github/pyxem/orix?branch=develop
 
-.. |docs| image:: https://readthedocs.org/projects/orix/badge/?version=latest
-.. _docs: https://orix.readthedocs.io/en/latest
+.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/orix.svg?label=PyPI%20downloads
+   :target: https://pypi.org/project/orix/
 
-.. |pypi_version| image:: https ://img.shields.io/pypi/v/orix.svg?style=flat
-.. _pypi_version: https://pypi.python.org/pypi/orix
+.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/orix.svg?label=Conda%20downloads
+   :target: https://anaconda.org/conda-forge/orix
 
-.. |downloads| image:: https://anaconda.org/conda-forge/orix/badges/downloads.svg
-.. _downloads: https://anaconda.org/conda-forge/orix
+.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3459662.svg
+   :target: https://doi.org/10.5281/zenodo.3459662
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-.. _black: https://github.com/psf/black
+.. |GPLv3| image:: https://img.shields.io/github/license/pyxem/orix
+   :target: https://opensource.org/license/GPL-3.0
 
-.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3459662.svg
-.. _doi: https://doi.org/10.5281/zenodo.3459662
+.. |GH-discuss| image:: https://img.shields.io/badge/GitHub-Discussions-green?logo=github
+   :target: https://github.com/pyxem/orix/discussions
 
-orix is an open-source Python library for analysing orientations and crystal symmetry.
+.. |binder| image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/pyxem/orix/HEAD
 
-The package defines objects and functions for the analysis of orientations represented
-as quaternions or 3D rotation vectors accounting for crystal symmetry. Functionality
-builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
-<https://matplotlib.org>`_ and is heavily inspired by the MATLAB package `MTEX
-<https://mtex-toolbox.github.io>`_.
+.. |docs| image:: https://readthedocs.org/projects/orix/badge/?version=latest
+   :target: https://orix.readthedocs.io/en/latest
 
-orix is released under the GPL v3 license.
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
++----------------------+------------------------------------------------+
+| Deployment           | |pypi_version| |conda|                         |
++----------------------+------------------------------------------------+
+| Build status         | |build_status| |docs| |python|                 |
++----------------------+------------------------------------------------+
+| Metrics              | |Coveralls|                                    |
++----------------------+------------------------------------------------+
+| Activity             | |pypi_downloads| |conda_downloads|             |
++----------------------+------------------------------------------------+
+| Citation             | |doi|                                          |
++----------------------+------------------------------------------------+
+| License              | |GPLv3|                                        |
++----------------------+------------------------------------------------+
+| Community            | |GH-discuss|                                   |
++----------------------+------------------------------------------------+
+| Formatter            | |black|                                        |
++----------------------+------------------------------------------------+
 
 Documentation
 -------------
@@ -65,17 +96,17 @@ or ``conda``::
 
     conda install orix -c conda-forge
 
-You can also visit `PyPI <https://pypi.org/project/orix>`_, `Anaconda
-<https://anaconda.org/conda-forge/orix>`_ or `GitHub <https://github.com/pyxem/orix>`_
-to download the source.
+The source code is hosted in `GitHub <https://github.com/pyxem/orix>`_, and can also be
+downloaded from `PyPI <https://pypi.org/project/orix>`_ and
+`Anaconda <https://anaconda.org/conda-forge/orix>`_.
 
-Further details are available in the `installation guide
-<https://orix.readthedocs.io/en/latest/user/installation.html>`_.
+Further details are available in the
+`installation guide <https://orix.readthedocs.io/en/latest/user/installation.html>`_.
 
 Citing orix
 -----------
 
 If analysis using orix forms a part of published work please cite the paper (`journal
 <https://doi.org/10.1107/S1600576720011103>`_, `arXiv
-<https://arxiv.org/abs/2001.02716>`_) and/or `the software
+<https://arxiv.org/abs/2001.02716>`_) and `the software
 <https://doi.org/10.5281/zenodo.3459662>`_.
diff --git a/doc/index.rst b/doc/index.rst
@@ -5,9 +5,10 @@ orix |release| documentation
 orix is an open-source Python library for analysing orientations and crystal symmetry.
 
 The package defines objects and functions for the analysis of orientations accounting
-for crystal symmetry. Functionality builds primarily on `NumPy <https://www.numpy.org>`_
-and `Matplotlib <https://matplotlib.org>`_, and is heavily inspired by the MATLAB
-package `MTEX <https://mtex-toolbox.github.io>`_.
+for crystal symmetry.
+Functionality builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
+<https://matplotlib.org>`_.
+Initiation of the package was inspired by `MTEX <https://mtex-toolbox.github.io>`_.
 
 .. toctree::
     :hidden: