GitHub README Generator
0/5 steps0%

Step 1 of 5

Write the hook section

The first screen decides if anyone keeps reading.

First time here? Paste the Context Pack first so the AI understands your project - open it from the header above.

Prompt Capsule
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]
Paste into EmergentFull Build: complete implementation prompt with explicit requirements

Quick is short. Full Build is recommended for most steps. Strict forces real logic when the AI keeps faking output.

Actual change check

Expected after this step

An above-the-fold hook: one-liner, why, visual plan, feature bullets.

Should NOT happen

  • An existing feature broke
  • A button only logs to console
  • Data disappears after refresh
  • Errors fail silently with no visible state

This is what should exist before you continue. If reality does not match, do not move on.

Track what changed, failed, or needs follow-up. Notes export with the flow.

Made with Emergent