alan-turing-institute / data-safe-haven

https://data-safe-haven.readthedocs.io
BSD 3-Clause "New" or "Revised" License
61 stars 15 forks source link

Replace emoji codes with characters in README #2178

Closed JimMadge closed 2 months ago

JimMadge commented 2 months ago

:white_check_mark: Checklist

:vertical_traffic_light: Depends on

:arrow_heading_up: Summary

Use emoji characters as the GitHub keys do not render in other places where the README is sourced (e.g. PyPI).

:closed_umbrella: Related issues

:microscope: Tests

jemrobinson commented 2 months ago

Is there any other README tidying up we'd like to do in this PR?

github-actions[bot] commented 2 months ago

Coverage report

This PR does not seem to contain any modification to coverable code.

jemrobinson commented 2 months ago

Can we add a PyPI link and download badge in this PR?

jemrobinson commented 2 months ago

Also - if we want to have a different README for PyPI than for GitHub, we can easily do that. Thoughts @JimMadge @craddm ?

JimMadge commented 2 months ago

Also - if we want to have a different README for PyPI than for GitHub, we can easily do that. Thoughts @JimMadge @craddm ?

I'd rather have one if possible. I would guess otherwise we risk the two documents getting out of sync.

JimMadge commented 2 months ago

@jemrobinson Do you like the badge with the PyPI version?

We could also do something like

Static Badge
jemrobinson commented 2 months ago

Maybe add the "number of downloads" badge too? Also we could separate/re-order the badges onto different lines, grouping by type e.g. facts (version number, licence, number of contributors), variable statuses (test results, PyPI downloads), ways to contribute (e.g. Slack, email?).