GitHub README Generator

Write a README that makes people use your project: hook, quickstart, visuals, and honest docs.

5 steps15 verify checks30-60 minutesWorks with: emergent · chatgpt · claude · cursor

Start Guided Walkthrough

#readme #github #docs #open-source #documentation

The Route

0/5 verified

Write the hook section

The first screen decides if anyone keeps reading.

3 checks 02

Write the quickstart

From zero to running in minimal, tested steps.

3 checks 03

Write usage and examples

Show the main use cases with real, current code.

3 checks 04

Add project meta

Status, license, and contribution basics complete the trust picture.

3 checks 05

Test the README cold

Follow it literally on a clean setup - fix every stumble.

3 checks

Every step ends at a Verify Gate. Do not continue until every check passes.

Context Pack

Paste this first. It briefs the AI on requirements, constraints, and the Definition of Done before your first build prompt.

Context Pack

PROJECT CONTEXT:
My repo needs a README that explains the project fast and gets people to try it.

GOAL:
Produce a complete README: what/why hook, a working quickstart, usage examples, and contribution basics.

REQUIREMENTS:
- A what-and-why section in the first screen
- A quickstart that actually works when followed
- Usage examples with real commands/code
- Screenshots or demo visuals
- Honest status, license, and contribution notes

CONSTRAINTS:
- The quickstart must be tested by following it literally
- No badge walls without substance

DEFINITION OF DONE:
- A stranger understands the project in 30 seconds
- The quickstart works copy-paste on a clean machine
- Examples cover the main use cases
- Status and limitations are honest

COMMON FAILURES TO AVOID:
- 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

Paste this into your AI builder first. It teaches the AI what you want before you give it the build prompt.