DOC: Add different GitHub badges to the README.rst file.
#1425
Conversation
|
Not sure whether the release number is being displayed correctly. Check in Related information I set the order of the badges to what I thought was sensible. Subject to comments. Also, IMHO out home page would be more appealing if we added the DIPY logo (?), like in: |
Codecov Report
@@ Coverage Diff @@
## master #1425 +/- ##
=========================================
- Coverage 87.42% 87.4% -0.03%
=========================================
Files 239 239
Lines 30579 30579
Branches 3291 3291
=========================================
- Hits 26735 26727 -8
- Misses 3075 3081 +6
- Partials 769 771 +2
Continue to review full report at Codecov.
|
jhlegarreta
force-pushed
the
AddGitHubBadges
branch
from
c973808
to
299830c
Compare
|
299830c was rebased on master. |
There was a problem hiding this comment.
I think, you can add some conda badges like platform or download.
I agree with you for adding DIPY Logo
README.rst
Outdated
| @@ -8,6 +8,15 @@ | |||
| .. image:: https://codecov.io/gh/nipy/dipy/branch/master/graph/badge.svg | |||
| :target: https://codecov.io/gh/nipy/dipy | |||
|
|
|||
| .. image:: https://img.shields.io/github/release/qubyte/rubidium.svg | |||
| :target: https://github.com/nipy/dipy/releases/latest | |||
There was a problem hiding this comment.
Since it does not work, we can replace it by:
.. image:: https://badge.fury.io/py/dipy.svg
:target: https://badge.fury.io/py/dipy
There was a problem hiding this comment.
It was not showing the right release because it was pointing to another repo (my bad!), but this is still not working:
https://img.shields.io/github/release/nipy/dipy.svg
API call:
https://api.github.com/repos/nipy/dipy/releases/latest
Compare the API call answer to
https://api.github.com/repos/insightsoftwareconsortium/itk/releases/latest
In any case, for now I ignore what's wrong, and I'm leaving the PyPI version (using the "official" or more common badge server Serge):
.. image:: https://img.shields.io/pypi/v/dipy.svg
:target: https://pypi.python.org/pypi/dipy
README.rst
Outdated
| :target: https://github.com/nipy/dipy/releases/latest | ||
|
|
||
| .. image:: https://img.shields.io/pypi/pyversions/Django.svg | ||
| :target: https://pypi.python.org/pypi/dipy |
There was a problem hiding this comment.
is it really necessary to show python version? IMHO, you can remove it
There was a problem hiding this comment.
Again, my fault: it was showing Django's. I think knowing which python versions are supported is worthwhile, but looks like that is only possible for PyPI, and it is not working wither for DIPY, so I'm removing it.
README.rst
Outdated
| :target: https://pypi.python.org/pypi/dipy | ||
|
|
||
| .. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg | ||
| :target: https://github.com/nipy/dipy/blob/master/LICENSE |
Add GitHub badges to make DIPY's GitHub home page more informative. Specificically, add the - PyPI badge - Conda platforms - Conda downloads - License badge
jhlegarreta
force-pushed
the
AddGitHubBadges
branch
from
299830c
to
a957ab0
Compare
|
Added the As for the logo, please let me know where I can find a high resolution version to add it. Thanks. |
|
Currently, you can use:
But we definitively have to add a better logo in this repo. |
|
ok, Thanks @jhlegarreta, merging! |
DOC: Add different GitHub badges to the `README.rst` file.
Add GitHub badges to make DIPY's GitHub home page more informative.
Specificically, add the