README.md

The README.md (or README.rst) is a file in Markdown describing the project, how to install it, how to use it... See makeareadme.com

  • ✍️ What's the project's name and goal/description
  • 🧸 How can we install it? Run it? Test it?
    • Add examples (GIF, I/O, demo...)
    • Provide a link to some documentation
  • 📦 Why have you made this project? Who is your audience?
  • 🌳 Credits, maintainers, contributors, license...

➡️ See also: GitHub - About README.md.

A lot of developers are using badges to show some information about the project such as badge. See shields.io, badgen.net, markdown-badges, unmaintained.tech, and license badges.

There are a few metrics you may also show:

💡 On GitHub, you can put the README.md in /docs/.

🎉 Fancy GitHub 🎉

On GitHub, READMES are used for many things other than just the README of a project. For instance, we may use a README.md to populate our profile, or our organization profile.

General

Metrics