Whenver I write a README for something I've made I usually include some deployment, running, installation instructions etc.
I try to write them for someone with very little knowledge of Linux, or the terminal. While learning for the first time I ran into far too many instructions that assumed I knew much more than I did, which was very frustrated (looking at you, any guide that suggests using vi
to edit basic config files).
And also, because I know in about a month's time, when I return to said instructions, I will have completely forgotten whatever the fuck I was doing and will really appreciate aforementioned instructions.