Ask HN: What Makes a Good Readme.md

There are checklists out there. This is the first one I came across while Googling:

https://github.com/ddbeck/readme-checklist

I'd be interested in any good checklists that people can recommend.

A brief statement of purpose and the exact commands required to get started, verified by CI. I mean, you have a CI job (travis, github actions, etc.) that parses your README.md and ensures it does what it purports to do.

Ask the newest engineer on the team whether they could extent the library with what is there. If no, it's not good enough.