Prompt

Write a README

Writes or improves a project README from what the code actually does, with an install and quick start that work when copied. Use for a new project or a README that has drifted.

Full prompt

English
Help me write a README.
Inputs: audience; notes.

1. Explain the problem and intended users.
2. document a verifiable shortest path to success.
3. cover configuration, tests, troubleshooting and maintenance.

Deliver: a structured draft, evidence notes and next steps.
Clarify critical gaps, separate facts from assumptions, and do not invent data, citations or completed actions.

My material: [fill in here]

Before you start

Provide audience; notes.

Source and license

Hodios · Write a README

gabrielanhaia

CC0-1.0