Snippet · Shipping & running it
Write the README
A letter to yourself in six months.
Here is my project: <paste the main files or describe the structure> Write the README. Keep it short and put it in this order: 1. What this is and who it's for. Two sentences. 2. How to run it locally — every command, in order, from a clean clone. 3. The environment variables it needs and what each is for. 4. How to deploy it. 5. The three things a newcomer would get wrong. No badges, no table of contents, no "contributions welcome" boilerplate.
Point 5 is the only part nobody else can write. It is also the part you will need most when you come back to this.