Adding a README.md isn't just GitHub specific, it's a good idea to add it to any project you do.
My memory sucks, that's why I write down what I'm planning to do with a project into the readme. It doesn't need to be super fancy with images and status badges and all that jazz.
This is perfectly enough:
projectname
===========
This fizzes
TODO
----
Add buzzing later
Check if bazzing library is ready for production
However, I strongly associate Readme.md, designed for a web based intro view with Github.
It would be interesting to get the real history, because it could be a fluke of timing.
Iād bet if we look back at old source forge projects created pre-github there would be a strong correlation with the markdown version added and the rise of github.
(Of course this could be a timing fluke)
My memory sucks, that's why I write down what I'm planning to do with a project into the readme. It doesn't need to be super fancy with images and status badges and all that jazz.
This is perfectly enough: