-
Notifications
You must be signed in to change notification settings - Fork 77
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
READMEs written with this checklist! #8
Comments
I just gave a README facelift to another of my repos using this guide: https://github.com/dib-lab/kevlar. I really like the effect of the drop-downs in the rendered README, although it does unfortunately reduce readability of the document in plain text. |
I have tried to follow your scheme on this page: Thanks for your work! |
Oh hey there's a list! I use this checklist a lot, although I sometimes skip or combine parts depending on the size and seriousness of the project. Here's some:
|
I came across this repository via the pyvideo from 2016 and I used it (not fully, though for lack of time) to improve this readme https://github.com/open-plan-tool/simulation-server Thanks for going through so many readme and for the effort of summarizing it then! |
Here's my take for https://github.com/trovu/trovu. Could even manage to keep the README very short. Hope it's still understandable. Thanks for writing this checklist! |
A hall of fame:
The text was updated successfully, but these errors were encountered: