I read through the earliest README I could find. Written in 1975 by William J. Earl at the CS department of UIC. The text is a little dry but also ...
For further actions, you may consider blocking this person and/or reporting abuse
I always add a Rational section just after the description. To explain the whys behind my code.
That’s a really neat idea, Victor 👍
Here's a couple of resources that I really liked when I was doing my own research on how to write a README:
I have created a repository for awesome github profile aims to collect the all awesome beautiful READMEs profile and make your Profile look good & Inspire other's.
Thanks, great post and really helpful :-)
Nice post, your favorite's README is the one I am using for my project: github.com/tuandm/laravue.
Also a proper GitHub readme should have a Gitpod button, so contributors can skip the setup part.
See e.g. github.com/thepracticaldev/dev.to#...
Gitpod is an awesome technology!
Awesome stuff, thanks.
Great post. Thanks for sharing.
Asciidoc README with table of contents is Nirvana: github.com/cirosantilli/linux-kern...
Thanks for sharing. This looks amazing!
Here's a readme that I made recently.
github.com/sndp487/share-it/blob/m...
Great post, thanks.
I would add: it's crucial to Keep Your Example Code Green .
Yes! I’ve ran into this problem on a repository recently.
Nice one!! You guys may wish to refer this one ;)
dev.to/pratikaambani/a-meaningful-...
I enjoyed reading this. It was satisfying to learn something while finding out about new tools I probably would have never found about any other way. Thank you 👏
Thanks Mayuran!