Stage 6 · Lesson 7 of 8
README and a short demo
A project nobody can run might as well not exist. The README is the a stranger reads first, so write it for a stranger. It should say in one line what the project does and for whom.
Show a screenshot or , and give exact install and run steps that work on a fresh machine. Add an example of input and output, how to run the tests, and what you would do next. Then a demo of under two minutes, as a GIF in the README or a short video, showing the tool solving the real problem.
Test the README yourself: (download a copy of) your into a new folder and follow it word for word, or ask a friend to. Anything you had to do that the README does not say is a bug.
A question to check yourself, an AI practice session and 1 cheat sheet entry come when you add the roadmap to your account. Add it
Resources for this stage
Start with
- GitHub repoFreeProject Based Learning
Community maintained · Beginner
Follow one guided build in your language, then build your own without a guide
Keep handy
Also worth your time
How to present each project: the problem, stack, challenges and results
- Build Your Own XGo deeper
When you want a harder build: a shell, a key-value store or a tiny Git, from scratch