What you will find in this article?
You've probably stumbled upon many GitHub repositories, each with their own unique README page. Have...
For further actions, you may consider blocking this person and/or reporting abuse
Really nice, clear article.
It is unfortunate that not all ReadMes are as clear as they should. This is a really good article for any open-source developer to familiarize with.
Thanks for sharing
Thank you Elijah 🙌 This README is most suited for an "application" type project. There are so many other projects like libraries, packages, non-code projects that require some different README content.
Most def, but this is like a foundation for all to me.
My library actually includes most of the things you mentioned here and many other principles.
That's fantastic 🤩
Very well-written article Marc.
Does one thing and does it well. Loved reading it!
Thanks Sumit! Sometimes simple way is the best way
'The ultimate sophistication' for a reason!
I find a TOC (table of content) very useful as well.
A good tool is bitdowntoc
Yes absolutely. Table of contents are underrated. Even though GitHub auto-generates it based on the headers, I never open them. When they are embedded in the README it's 100x more useful.
Definitely going back and rewriting some of my README's now! This is really slick.
Thank you Oscar! Definitely let me know how it turns out. I'm always interested to learn from others
Need to update mine now
Go Go Go! It's never been easier. Also check out readme.so
Excellent post. Loved the concept of gifs. Need to tinker with a few README pages that I have in my own repos; need some improvement.
Oh gifs in the README are a gamechanger. Makes it really interactive and catchy for people to understand the most valuable aspect of your project.