Elegant READMEs

Some time ago I wrote a blog post An Open Code Base Is Not Yet an Open Source Project where I suggested a few important qualities of a good open source repository/project. One of them was the well-written README file. Here I will try to give a few hints on how to create a good README file and what mistakes to avoid. I hope you find it helpful.

[image error]Life of Pi (2012) by Ang Lee

I will list everything you need to have in the README, in the order those elements should show up:

Title and Description...