awesome-readme

A curated list of well-made README files. It serves as inspiration for writing clear, attractive project documentation.

Share on XNo license declared

Overview

Awesome README is a curated list of projects with well-made README files. The list points out what makes each one work, such as a logo, a clear description, screenshots, GIFs, badges, a table of contents and step-by-step install instructions. It is meant as inspiration when you write documentation for your own project.

Key features

  • Curated links to projects with strong READMEs
  • Notes on what each README does well
  • Covers images, screenshots, GIFs and text formatting

Best for

Maintainers who are writing or improving a README and want concrete examples to learn from.

Upstream
rogersaloo/awesome-readme
Fork on GitHub
Guo-astro/awesome-readme
Upstream stars
1
Category
Learning, interviews and curated lists
License
No license declaredWithout a license, the author keeps all rights. Ask the upstream owner before reusing the code.
Forked
2024-01-20
Sync status
In syncLast synced 2026-09-29