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

Add Shields to README #213

Merged
merged 5 commits into from
Mar 2, 2023

Conversation

roryjamesallen
Copy link
Collaborator

Groundwork for adding shields to the README.
I've done the easy ones (socials), next is the suggestions from the Discord, so version, pydocs, contributor count.

@awonak
Copy link
Collaborator

awonak commented Jan 3, 2023

Here are some suggestions, pick any that look useful or interesting to you:

GitHub release (latest SemVer)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Allen-Synthesis/Europi)

GitHub contributors

![GitHub contributors](https://img.shields.io/github/contributors/Allen-Synthesis/EuroPi)

GitHub repo file count (file extension)

![GitHub repo file count (file extension)](https://img.shields.io/github/directory-file-count/Allen-Synthesis/EuroPi/software/contrib?extension=py&label=contrib%20scripts&type=file)

GitHub all releases

![GitHub all releases](https://img.shields.io/github/downloads/Allen-Synthesis/EuroPi/total?label=release%20downloads)

PyPI - Downloads

![PyPI - Downloads](https://img.shields.io/pypi/dm/micropython-europi?label=PyPi%20downloads)

Search around https://shields.io/ if you're curious about other options.

@awonak
Copy link
Collaborator

awonak commented Jan 3, 2023

Also, here's some alternative MarkDown versions of the social tags:

Subreddit subscribers

![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/EuroPi?style=social)

Subreddit subscribers

![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/EuroPi?style=flat)

Discord

![Discord](https://img.shields.io/discord/931297838804127794?style=social)

Discord

![Discord](https://img.shields.io/discord/931297838804127794?label=Discord&style=flat)

<img src="https://img.shields.io/reddit/subreddit-subscribers/europi?style=social"
alt="chat on Discord">
</a>
<a href="">
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<a href="">
<a href="https://github.com/Allen-Synthesis/EuroPi/tree/main/software/contrib">

@@ -1,6 +1,27 @@
# EuroPi

The EuroPi is a fully user reprogrammable module based on the [Raspberry Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/), which allows users to process inputs and controls to produce outputs based on code written in Python. The entire project is open-source.

### The EuroPi is a fully user reprogrammable module based on the [Raspberry Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/), which allows users to process inputs and controls to produce outputs based on code written in Python. The entire project is open-source.
Copy link
Collaborator

Choose a reason for hiding this comment

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

[optional] I think the larger font here is a little distracting, imho it's fine without.


---

<p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

[optional] Most repos will start with the main title, immediately followed by the shields, then the summary paragraph. It's fine in this order too though if you prefer.

Copy link
Collaborator

@mjaskula mjaskula left a comment

Choose a reason for hiding this comment

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

Looks good to me. I'd like to see some more developer-focused metrics here as well, since this is github. For example, the release version as @awonak suggested, or the latest build status. But this is a good start.

@mjaskula mjaskula merged commit 3550a57 into Allen-Synthesis:main Mar 2, 2023
@roryjamesallen roryjamesallen deleted the add-discord-shield branch February 6, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants