Update README to use status badge table, rephrase reference to MTEX - Githubissues

pyxem / orix

Analysing crystal orientations and symmetry in Python

https://orix.readthedocs.io

GNU General Public License v3.0

78 stars 45 forks source link

Update README to use status badge table, rephrase reference to MTEX #486

Closed hakonanes closed 2 months ago

hakonanes commented 2 months ago

Description of the change

The current README.rst have started to show underscores after badges. Should be fine now.

Given how much this project has moved on from its beginning, I've rephrased the reference to MTEX in the README from

[...] heavily inspired by the MATLAB package MTEX.

to

Initiation of the package was inspired by MTEX.

I've organized badges in a table similar to how we do it in kikuchipy, which was inspired by PyVista.
And, I've changed the phrasing under "Citing orix" slightly to more strongly encourage citation of both the 2020 paper and the software (Zenodo DOI).

Progress of the PR

[n/a] Docstrings for all functions
[n/a] Unit tests with pytest for all lines
[n/a] Clean code style by running black via pre-commit

For reviewers

[ ] The PR title is short, concise, and will make sense 1 year later.
[ ] New functions are imported in corresponding __init__.py.
[ ] New features, API changes, and deprecations are mentioned in the unreleased section in CHANGELOG.rst.
[ ] Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in .zenodo.json.