-
Notifications
You must be signed in to change notification settings - Fork 78
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
Add Shields to README #213
Conversation
Here are some suggestions, pick any that look useful or interesting to you:
Search around https://shields.io/ if you're curious about other options. |
Also, here's some alternative MarkDown versions of the social tags:
|
<img src="https://img.shields.io/reddit/subreddit-subscribers/europi?style=social" | ||
alt="chat on Discord"> | ||
</a> | ||
<a href=""> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<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. |
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
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.