Blog / documentation
How to write a README for an AI-built project
A README is the first thing a visitor reads in your repository. It should let a stranger understand and run your project in a couple of minutes.
The structure
- One sentence: what it is and who it is for.
- A screenshot or short video.
- How to run it, as a short list of commands.
- What it is built with.
- Where to read the story of how it was made.
Let the AI draft, then fix it
Ask an assistant to write a README from your code, then check every command it claims works. Models sometimes invent steps.
Say what is unfinished
A short “status” line sets expectations. Saying “early beta, expect rough edges” is better than letting people discover it.
Link your build log
A README tells people what the project is. A build log tells them how it came to be. Link to it, or add a live badge to the top that shows the stage and your newest entry number.
Keep it short
People skim. Put the most important things first and link out to anything longer.
Keep your own build log
Write numbered entries, follow other builders, and let people watch your idea become real.
Join vibFolio