updating the README.md - Githubissues

aiidateam / aiida-core

The official repository for the AiiDA code

https://aiida-core.readthedocs.io

Other

436 stars 189 forks source link

updating the README.md #3469

Closed ltalirz closed 5 years ago

ltalirz commented 5 years ago

I think the 1.0 release is a good opportunity to give the rather outdated README.md a bit of a polish.

I plan to:

[x] add the AiiDA logo
[x] borrow the short description of features from the docs
[x] add a number of badges
- [x] conda-forge
- [x] license
- [x] pypi stats
- [ ] ~~feature request issues vs bug issues (?)~~
- [ ] ~~percentage of open issues (?)~~
- [x] mailing list
- [ ] ~~code quality~~

ltalirz commented 5 years ago

Other ideas for the future (not now):

enlisting "code helpers", see e.g. https://www.codetriage.com/ipython/ipython/
a gitter chat (many repos offer it)

Stashing away code for some badges we might want to add later

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8999582609ea438693156fb4a0b21d2f)](https://www.codacy.com/manual/aiidateam/aiida-core?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=aiidateam/aiida-core&amp;utm_campaign=Badge_Grade)

ltalirz commented 5 years ago

following discussion with @sphuber and @giovannipizzi, moving badges related to development activity to a wiki page in order not to overload the README. https://github.com/aiidateam/aiida-core/wiki/Issue-Triage