Wow, the first readme linked is horribly ugly and provides no context above the fold. It looks like the zodiac killer’s rear bumper.
> Changelog [...] is something from Pre-GitHub time. I would recommend you rely on the "releases" tab
> GitHub has a special tab in each repository, which is called “contributors.” There is absolutely no reason to reproduce the list in the README file.
Why would you tie yourself to github like that?
We super need these kind of content, in Portuguese
The advice about badges reads like parody to me. I only really care if the project has CI. The Zoid repo has way too many!
I focus on making sure the mobile view of the github page has a compelling summary of the state of the project “above the fold”:
- purpose and goal
- programming language
- software type: library, framework, language, CLI, server, etc
- maturity: age, production-readiness, prominent users, corporate backing
Logo is a nice-to-have.