Software A README for your future self Write down the parts you would otherwise have to rediscover.
A useful README answers three questions: what does this project do, how do you run it, and what should you check when something goes wrong?
Start with the shortest working command. Put configuration examples beside it, with secrets replaced by obvious placeholders. If a step depends on a particular version, say which one.
The best test is to leave the project alone for a while, then follow your own instructions. Anything you have to remember belongs in the file.