Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Apr 12, 2024

Conversation

hakonanes
Copy link
Member

Description of the change

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

  1. 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.

  1. I've organized badges in a table similar to how we do it in kikuchipy, which was inspired by PyVista.

  2. 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

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.

@hakonanes hakonanes added the dev Package maintenance label Apr 11, 2024
@hakonanes hakonanes added this to the v0.12.0 milestone Apr 11, 2024
@hakonanes hakonanes requested review from harripj and pc494 April 11, 2024 19:16
@hakonanes hakonanes mentioned this pull request Apr 11, 2024
8 tasks
Signed-off-by: Håkon Wiik Ånes <hwaanes@xnovotech.com>
Copy link
Collaborator

@harripj harripj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing the underscores, nice spot! I'm happy with all the changes here.

@hakonanes hakonanes merged commit 8620292 into pyxem:develop Apr 12, 2024
13 checks passed
@hakonanes hakonanes deleted the update-readme branch April 12, 2024 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev Package maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants