TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

How to make a good-looking README for a GitHub repo?

15 pointsby yegor256aabout 6 years ago

4 comments

jitlabout 6 years ago
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!<p>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”:<p>- purpose and goal<p>- programming language<p>- software type: library, framework, language, CLI, server, etc<p>- maturity: age, production-readiness, prominent users, corporate backing<p>Logo is a nice-to-have.
评论 #19731166 未加载
wutwut5521about 6 years ago
Wow, the first readme linked is horribly ugly and provides no context above the fold. It looks like the zodiac killer’s rear bumper.<p><a href="https:&#x2F;&#x2F;github.com&#x2F;zold-io&#x2F;zold" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;zold-io&#x2F;zold</a>
earenndilabout 6 years ago
&gt; Changelog [...] is something from Pre-GitHub time. I would recommend you rely on the &quot;releases&quot; tab<p>&gt; 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.<p>Why would you tie yourself to github like that?
uiraabout 6 years ago
We super need these kind of content, in Portuguese