I'm not completely fan of, but worth reading:

Readme Driven Development
tom.preston-werner.com/2010/08

Please, do

git commit -m'Add license, readme'

instead of

git commit -m'Initial commit'

Follow

Also, when writing readme, it may help writing it for yourself. So it could be interesting to ask questions like:

- Not gonna to read this, how could I write it shorter?

- Not gonna understand it tomorrow, WHAT's the point?

- This sounds stupid, WHY is that?

- I will do this all the time, but HOW?

- I have a question/bug -- WHERE/WHO to report?

Sign in to participate in the conversation
En OSM Town | Mapstodon for OpenStreetMap

The social network of the future: No ads, no corporate surveillance, ethical design, and decentralization! Own your data with Mastodon!