Hacker News Reader

I usually add in:

* How to build it

* How to install it

* How to run it

* What other software or special hardware it needs

You know, all the stuff I'll forget when I come back to the code after six months and would rather not have to figure out anew.

View on HN

Dont forget:

* What it does * What it's for

Yes, that too. :) The point is to document the sorts of things you wish had been documented for you to orient yourself when you have to pick up a strange code base. Because that person is you in six months.

Reply on news.ycombinator.com