README From the Repository skill for Claude and Codex

README From the Repository as an AI skill. It asks for Project summary, Repository contents, Run and setup details and 3 more, then does the rest. Free to…

Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.

Download the skill (.zip) · View SKILL.md

When it is used

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.

What it will ask you for

• 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")

How it works

1. Write the opening name, one-sentence description and problem statement so a visitor can decide quickly if it is relevant.
2. Compose the Quick start using only commands present in the supplied details.
3. Build the Configuration table with name, purpose, default and required flag, leaving out secret values.
4. Add Commands and, for contributors, the project structure and pre-pull-request checks.
5. Close with License and Support, and list every section where the source material was too thin.

What you get

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.

What it watches out for

• 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.

How to install

Claude.ai and the Claude desktop app

1. Download the skill .zip.
2. Open Settings, then Capabilities, and find Skills.
3. Choose Upload skill and select the .zip.
4. Ask Claude for help with the task. It loads the skill when your request matches.

Claude Code

1. Download the skill .zip.
2. Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
3. Start a new session. Claude Code loads the skill when your request matches.

Codex

1. Download the skill .zip.
2. Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
3. Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.

Cursor

1. Download the Cursor rule (.mdc).
2. Save it in .cursor/rules/ inside your project.
3. Cursor's agent applies the rule when your request matches its description.

AGENTS.md (Codex, Cursor, and other coding agents)

1. Copy the AGENTS.md section.
2. Paste it into AGENTS.md at the root of your repository, creating the file if needed.
3. Coding agents that read AGENTS.md follow it when your request fits.