What in your opinion makes for a great README file?

This is an automated archive made by the Lemmit Bot.

The original was posted on /r/opensource by /u/YanTsab on 2025-05-11 14:10:07+00:00.

---

I’m officially on the final stage of open-sourcing my project - writing the README file.

I would appreciate an input from the community - what do you think makes for a great README file? What do you look for first? What are must haves?

I’ve noticed some big differences between popular packages. It doesn’t seem like there’s a clear format for what to include.

So - what is it for you?