Stage 6 · Lesson 6 of 7
README with build steps
The README is your , and for a C++ project its hardest job is explaining the build. List the compiler and versions you tested with. Give the exact commands to configure, build and run the tests, the steps for each platform you support, and any the user must install first.
Then show what the tool does: a sample input file in the , the command to run it, and the output it prints. Add a short demo as a GIF or a pasted terminal session. Test the README by cloning into a fresh folder and following it word for word.
Ideally do this on a different or in a container (a clean, isolated system). Every step you had to guess is a bug in the README.
A question to check yourself, an AI practice session and 2 cheat sheet entries 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