agentleFS
Sign inStart free
kakarot-oncloudkakarot-oncloud/claude-dev-skills/skills/readme-generator/SKILL.md

readme-generator

Skill0 starsChanged 7 months agoMITView on GitHub

Generates project README.md files with the right sections (badges, install, usage, configuration, contributing, license) based on the project type and audience. Use this skill when the user asks to "write a README", "generate documentation", "make my repo presentable", or has a project that lacks a proper README.

37 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use book-chapter-generator, concept-classifier and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • vishalsachdevSkill

    book-chapter-generator

    This skill generates a structured chapter outline for intelligent textbooks by analyzing course descriptions, learning graphs, and concept dependencies. Use this skill after the learning graph has been created and before generating chapter content, to design an optimal chapter structure that respects concept dependencies and distributes content evenly across 6-20 chapters.

    Also in 3 projects that use this

  • vishalsachdevSkill

    concept-classifier

    Create an interactive classification quiz MicroSim using p5.js where students read scenarios and classify them into the correct category from multiple choice options. Uses a data.json file for easy question editing. Ideal for teaching students to recognize patterns, identify types, or categorize examples across any subject domain.

    Also in 3 projects that use this

  • JayRHaSkill

    changelog-keeper

    Maintains a CHANGELOG.md in the Keep a Changelog format with Semantic Versioning, grouping user-facing entries under Added/Changed/Deprecated/Removed/Fixed/Security and cutting dated releases from an Unreleased section. Use this skill when the user asks to "update the changelog", "add a changelog entry", "cut a release", "bump the version", "what changed since the last release", or to create/clean up a CHANGELOG.md or release notes.

    Also in 3 projects that use this

  • ATOM00blueSkill

    error-message-explainer

    Explains errors, stack traces, exceptions, and cryptic build/runtime messages in plain language, identifies the root cause, and gives a concrete fix. Use when the user pastes an error, stack trace, traceback, panic, compiler error, or failing log and asks what it means, why it happens, or how to fix it.

    Also in 3 projects that use this

  • peopleforresterSkill

    refactoring-guide

    Safe refactoring patterns and techniques. Use when the user wants to improve code structure, reduce duplication, or make code more maintainable without changing behavior. Emphasizes incremental changes with test coverage.

    Also in 3 projects that use this

  • +7 more from vishalsachdev

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 31 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Real install command first: Don't bury the install behind 3 paragraphs of context.

    line 84
  2. Distinctive:

    Working examples: Every code block should be runnable as-is.

    line 85
  3. Distinctive:

    If the user just says "write a README for my project", ask for:

    line 92
  4. Very specific:

    If you have access to the codebase (package.json, pyproject.toml, Cargo.toml, etc.), infer as much as possible before asking.

    line 100

“Common” is measured: kept by at least 6 in 10 of the 31 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

README Generator

You write README files that get a new user from "what is this" to "I'm using it" in under two minutes.

Standard structure

# <Project Name>

<One-sentence tagline that explains what this is.>

[badges: build, version, license, downloads]

<2-3 sentence elevator pitch — problem solved + who it's for>

## Features

- Bullet 1
- Bullet 2
- Bullet 3

## Installation

\`\`\`bash
<one command if possible>
\`\`\`

## Quick start

\`\`\`<lang>
<minimal working example, 5-15 lines>
\`\`\`

## Usage

<more examples covering the main use cases>

## Configuration

<env vars / config file / CLI flags — only if applicable>

## API reference

<for libraries — link to full docs if they exist>

## Development

\`\`\`bash
git clone ...
<install deps>
<run tests>
<run dev server>
\`\`\`

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

<License name> — see [LICENSE](LICENSE).

Section selection by project type

TypeMust-have sections
CLI toolInstall, Usage (with command examples), Flags/options, Examples
Library / SDKInstall, Quick start, API reference, Examples
Web appScreenshot, Features, Install/Run, Configuration, Tech stack
Service / APIEndpoints summary, Auth, Quick start, Deployment, Health checks
Framework / templateWhat's included, Quick start, Project structure, Customization

Rules

  1. Tagline first. The first line after the title should answer "what is this" — not history, not motivation, not badges.
  2. Show, don't tell. Code examples beat prose. If you can demo it in 5 lines, do that instead of describing it.
  3. No empty sections. Skip "Roadmap" if there isn't one. No "TODO" placeholders.
  4. Real install command first. Don't bury the install behind 3 paragraphs of context.
  5. Working examples. Every code block should be runnable as-is.
  6. Link, don't duplicate. Long docs go in docs/. The README is the front door, not the manual.
  7. Badges in moderation. Build status + version + license is enough. 12 badges = noise.
  8. Match the tone of the project — playful for hobby projects, terse and clinical for enterprise tooling.

What to ask before writing

If the user just says "write a README for my project", ask for:

  1. Project name and one-line description
  2. Project type (CLI / library / app / service / other)
  3. Primary language and install method
  4. One usage example (or the entry-point file so you can infer it)
  5. License

If you have access to the codebase (package.json, pyproject.toml, Cargo.toml, etc.), infer as much as possible before asking.

Output

Produce the full README in a single fenced markdown code block, ready to save as README.md. Below it, list any sections you skipped and why, and any TODOs the user needs to fill in (screenshots, demo URLs, etc.).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free