wowprompt

README file for a project from code and setup notes

Writes a clear README in Markdown with project summary, installation, configuration, usage examples and contribution notes. Use it when publishing a repository, handing a project to a new developer or tidying up an internal tool.

A complete README with title, one-line summary, features, requirements, install steps, configuration table, usage examples, tests and licence
The output this prompt produced, unedited.

The prompt

Fill in these first

  • Project name and one-line purpose: [name, purpose]
  • Language and framework: [details]
  • Main features: [list]
  • Setup notes: [paste commands you run to install and start it]
  • Environment variables: [names and what each does, never the values]
  • Example usage: [a command, API call or screenshot description]
  • Licence: [e.g. MIT, Apache 2.0, proprietary]
  • Who reads this: [open source users, teammates, clients]

Task

Write a README.md that lets a new developer go from cloning the repository to a working run in under 15 minutes.

Output format

  1. Title and one-line summary.
  2. Features: up to seven bullet points.
  3. Requirements: versions of runtimes and tools.
  4. Installation: numbered steps with commands in code blocks.
  5. Configuration: | Variable | Required | Default | Description |
  6. Usage: two or three examples with expected output.
  7. Running tests.
  8. Project structure: a short tree of key folders with one line each.
  9. Contributing and licence.

Rules

  • Commands must be copy-paste ready for the stated operating systems.
  • Use placeholder values such as your-api-key for every secret.
  • No badges, links or features that the inputs do not support.
  • Keep sentences short; a README is scanned, not read.

Example

| DATABASE_URL | yes | none | Connection string for the main database |

readme templatereadme generatorgithub readmeproject documentationreadme mdopen source documentation

How to run this

Copy the prompt and paste it into Gemini, then set the aspect ratio to 3:4. No reference photo is needed for this one.

The prompt is written in Markdown with each part under its own heading, which is what the copy action hands over. Change one section at a time, keeping the rest intact, so you can tell which change did the work.

Related prompts

All productivity