A · Build proofBeginner35 min read
2. README as sales page
Portfolio That Hires · 20 pages source format
Problem, approach, how to run, architecture sketch, sample report. Assume zero Slack access.
What you'll learn
- README structure
- Screenshots / GIFs
- Honest scope
Write the README
Top: what it is + why. Then quickstart. Then design choices. Then limitations.
Do this now
Ship a README someone else can run in 15 minutes.
Pro tip. A diagram beats three paragraphs of folder poetry.
Clear?