Make use of README.md in setup.py, and update README.md to include some badges and an image #1069
Conversation
…me badges and an image.
| <a href="https://github.com/SciTools/cartopy/graphs/contributors"> | ||
| <img src="https://img.shields.io/github/contributors/SciTools/cartopy.svg" | ||
| alt="# contributors" /></a> | ||
| <a href="https://travis-ci.org/SciTools/cartopy/branches"> |
There was a problem hiding this comment.
This badge looks the same as the TravisCI badge, both are labelled build which is confusing (particularly since one is failing and one is passing, resulting in a confusing outlook for the state of the package).
There was a problem hiding this comment.
Yeah. I agree. The standard CircleCI badge is different, but entirely inconsistent (and to my eye, looks pretty terrible). I'm tempted to simply remove the circle-ci one - we only use it currently for docs building verification, I'm not sure it is that useful as an indicator of good repository management.
There was a problem hiding this comment.
OK let's lose the CircleCI one then.
|
Let's take this now. FWIW I am seeing an issue with loading all the badges, frequently one or two fail to load the image and when you reload the page you'll see another one or two are missing. This may just be load on shields.io or perhaps we have too many badges... In any case, it can be addressed later if needed. |
|
Thanks @ajdawson. The badges issue relates to badges/shields#1568. |
Rationale
Gives a little bit of polish to the README. There is a still a lot that can be done though.
I've tested this at https://test.pypi.org/project/Cartopy/#description. It can also be seen at https://github.com/pelson/cartopy/blob/markdown_readme/README.md.