---
name: readme-from-the-repository
description: "Drafts a README from the repository itself: what the project is, how to start, how to configure it, the commands and where to get help. Use when a repository lacks a README or has an outdated one, and visitors need to know what it is, how to start and how to configure it. Do not use for full documentation sites or API reference pages. Related topics: coding, writing."
---

# README From the Repository

Drafts a README from the repository itself: what the project is, how to start, how to configure it, the commands and where to get help.

## When to use

Use this skill when a repository lacks a README or has an outdated one, and visitors need to know what it is, how to start and how to configure it. Do not use it for full documentation sites or API reference pages.

## Workflow

1. Ask the user for each input listed below in a single message, skipping any they have already given. Where options are listed, offer them, but accept other answers too.
2. Write the opening name, one-sentence description and problem statement so a visitor can decide quickly if it is relevant.
3. Compose the Quick start using only commands present in the supplied details.
4. Build the Configuration table with name, purpose, default and required flag, leaving out secret values.
5. Add Commands and, for contributors, the project structure and pre-pull-request checks.
6. Close with License and Support, and list every section where the source material was too thin.

## Inputs

- **Project summary** (longer free text)
- **Repository contents** (longer free text)
- **Run and setup details** (longer free text)
- **Configuration** (longer free text)
- **Audience** (choose one: Users of the tool, Contributors, Both)
- **License and support** (free text, e.g. "License name and where to ask for help")

## Output

A README in Markdown with a title, description, Quick start, Configuration table, Commands, optional contributor section, License and Support, and a final list of gaps to fill.

## Prompt template

Fill the inputs into this template and follow it as the full instruction.

### README From the Repository

Write a README for this repository.

- Project summary: {{Project summary}}
- Repository contents: {{Repository contents}}
- Run and setup details: {{Run and setup details}}
- Configuration: {{Configuration}}
- Audience: {{Audience}}
- License and support: {{License and support}}

Open with the project name, a one-sentence description and the problem it solves, so a visitor knows in ten seconds whether it is for them. Follow with a Quick start of the fewest commands that give a working result, each one copied from the supplied details and never invented. Add Configuration as a table of names, purpose, default and whether it is required, with no real secret values. Add Commands for build, test and lint when they exist. For contributors include project structure and how to run the checks before a pull request. Close with License and Support. Use code blocks for anything typed. Flag in a final note every section where the supplied material was too thin and a human must fill in the facts, rather than writing plausible but untested instructions.

## Pitfalls

- Inventing install commands that were never run, so the first thing a newcomer types fails.
- Putting a real key or token in the configuration example.
- Writing a long history of the project before the Quick start, which hides the part visitors came for.