CapstoneLaunchLesson 69 / 69

Write your project README

Docs30 min

Write your project README

A README is a promise to a stranger: here is what this is, here is how to run it.

Four sections do the job:

  1. 1.What it is — one sentence, one screenshot.
  2. 2.Quick start — the exact commands, copy-pasteable, that make it run.
  3. 3.The stack and why — three bullets, honest reasons.
  4. 4.What's next — the honest cut list from your scoping lesson.

Write it for the engineer you were on day one of this roadmap — the one who needed "How the web works". You now know how it all fits together; the README is where you prove it.

Exercise

Write your capstone's README with the four sections. The quick start must be verified: run the commands yourself, from a clean clone.