← Back to Topics

README Improvements

Comments in this cluster focus on feedback requesting better README files for GitHub projects, including more descriptions, explanations, screenshots, and structure to make them more helpful and informative. Project authors often acknowledge the suggestions and commit to updating their READMEs.

➡️ Stable 0.8x Open Source
3,698
Comments
19
Years Active
5
Top Authors
#6419
Topic ID

Activity Over Time

2008
1
2009
14
2010
32
2011
58
2012
113
2013
124
2014
139
2015
178
2016
193
2017
213
2018
175
2019
230
2020
339
2021
312
2022
294
2023
355
2024
413
2025
473
2026
42

Top Contributors

brudgers (9) majewsky (8) detaro (8) swyx (8) johnisgood (8)

Keywords

GP LLM CONTRIBUTING.md forthebadge.com README.md GitHub README PR pico.sh love.svg readme md project repo instructions github thank feedback file explanation nice

Sample Comments

hekmatof • May 10, 2018 • View on HN

Thanks for your oponion, you'r right. I changed readme to be more legible and helpful.

Uchikoma • May 20, 2012 • View on HN

A little explanation in the README would be nice.

tolas • Dec 18, 2014 • View on HN

Agreed. A few sentences in the README would do wonders.

christophberger • May 27, 2017 • View on HN

The readme might deserve some love. A one-liner is not that helpful... :)

pnathan • Mar 3, 2016 • View on HN

Sounds cool, but your readme is quite anemic.

mgberlin • Mar 10, 2016 • View on HN

A readme that explains your project would go a long way.

tomcam • Jul 16, 2019 • View on HN

Super good explanation, and congrats this project. Would be helpful to your cause if you put this right in the README.md

degio • Apr 3, 2014 • View on HN

As you suggested, we've updated the README with the content above.

iambot • Jun 23, 2011 • View on HN

a README on the repo would be nice... #justsaying

talles • Aug 13, 2015 • View on HN

Kudos for stating on the README what it does.