readme-checklist icon indicating copy to clipboard operation
readme-checklist copied to clipboard

READMEs written with this checklist!

Open ddbeck opened this issue 7 years ago • 5 comments

A hall of fame:

ddbeck avatar Apr 04 '18 11:04 ddbeck

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.

standage avatar Jun 14 '18 03:06 standage

I have tried to follow your scheme on this page:

Thanks for your work!

zerothi avatar Mar 04 '19 11:03 zerothi

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:

relsqui avatar Sep 02 '19 07:09 relsqui

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!

Bachibouzouk avatar Jan 12 '23 15:01 Bachibouzouk

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!

georgjaehnig avatar Feb 21 '24 14:02 georgjaehnig