Step 1 of 5
Write the hook section
The first screen decides if anyone keeps reading.
Write my README's opening. I will describe the project below. Produce: the project name with a one-line description (what it does, for whom); a 2-3 sentence 'why' (the problem and what makes this approach worth trying); a hero visual plan (screenshot/gif of the most impressive moment - specify what to capture); and 3-5 honest feature bullets (capabilities, not adjectives). Everything above the fold. MY PROJECT: [describe here]
Expected after this step
An above-the-fold hook: one-liner, why, visual plan, feature bullets.
Should not happen
- ✕READMEs that never say what the thing does
- ✕Install steps missing prerequisites and failing immediately
- ✕Stale examples from three versions ago
- ✕Screenshots of an old UI or none at all
Verify before continuing
Do not move on until every check is true. The complete button stays locked until then.
Do not continue if…
- !READMEs that never say what the thing does
- !Install steps missing prerequisites and failing immediately
- !Stale examples from three versions ago
- !Screenshots of an old UI or none at all
If the AI messes this up
Use this when the AI fakes progress or breaks the feature. It forces a real fix.
The opening describes vibes, not function. Rewrite the one-liner as 'X does Y for Z' and turn every adjective bullet into a concrete capability.