readme-checklist
readme-checklist copied to clipboard
READMEs written with this checklist!
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.
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:
- oobash (a bash library for oop)
- awkward polaroid (a cartoon group portrait generator and accompanying twitter bot)
- finger tag (an android game)
- mtgcorpus (tools for grammatically analyzing Magic card text)
- screenguppy (a desk toy for your terminal)
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!