agentleFS
imtiazrayhanimtiazrayhan/agentscamp-library/skills/readme-generator/SKILL.md

readme-generator

Skill1 starsChanged 5 days agoMITView on GitHub

Generate or refresh a project README grounded in the actual repository. Use when a project has no README, a stale one, or you want install/usage/scripts/structure sections that match the real code.

  • Installs packages

39 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

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

  • 0

    Common

    Most of the 32 edited versions we read keep these.

  • 1

    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:

    Detect the stack — do not guess: Read the manifest that exists rather than assuming:

    line 22
  2. Very specific:

    Every command above came from the project's real scripts.

    line 84

“Common” is measured: kept by at least 6 in 10 of the 32 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

Produce a README.md that reflects what the repository actually contains — not a generic template. The skill detects the stack, build tooling, runnable scripts, entry points, and directory layout by reading real manifest files, then assembles a title, a one-line plus short description, and install / usage / scripts / project-structure sections. Every command it prints is one the project can actually run, so a new contributor can clone, install, and start without guessing.

When to use this skill

  • A project has no README, or an outdated one that no longer matches the code.
  • You want install and usage instructions derived from the real package.json / Makefile / pyproject.toml, not boilerplate.
  • You need a consistent, scannable README with the standard sections (install, usage, scripts, structure) in one pass.

[!WARNING] Never invent features, flags, or commands. If a script, entry point, or env var is not in the repo, it does not go in the README. When something is genuinely unknown (license, deploy target), insert a clearly marked <!-- TODO --> rather than fabricating it.

Instructions

  1. Locate the project root and existing README. Glob for README* at the root. If one exists, read it — preserve hand-written prose (project purpose, badges, screenshots, license) and only regenerate the mechanical sections. Treat the code as the source of truth where they disagree.
  2. Detect the stack — do not guess. Read the manifest that exists rather than assuming:
    • Node/TS: package.json (name, description, scripts, bin, type, engines), plus tsconfig.json, lockfile (package-lock.json / pnpm-lock.yaml / yarn.lock / bun.lock / bun.lockb) to pick the right package manager.
    • Python: pyproject.toml / setup.py / requirements.txt.
    • Go: go.mod. Rust: Cargo.toml. Make-driven: Makefile targets. Frameworks: infer from dependencies (next, react, fastapi, express) — do not claim a framework that isn't a dependency.
  3. Extract install and usage facts. Map the detected manager to the install command (npm install, pnpm install, pip install -e ., cargo build). Find the entry point (main/bin in package.json, cmd/ in Go, __main__.py). Pull the dev/start/build commands straight from scripts or Makefile targets — quote them verbatim.
  4. Map the structure. Glob the top-level directories and a shallow level below, ignoring node_modules, .git, dist, build, and .next. Annotate each meaningful directory with one short phrase describing what lives there, based on what you actually find.
  5. Assemble the README. Write README.md with: an # H1 title (from manifest name), a one-line tagline, a short paragraph, then ## Installation, ## Usage, ## Scripts (a table of every script + its command), and ## Project structure (a fenced tree). Keep it scannable; prefer fenced code blocks over prose for commands.
  6. Verify against the repo. Re-check that every script in the table exists in the manifest and every path in the tree exists on disk. Run npm run (or make) to confirm the script list matches, if available.
  7. Report and flag gaps. Summarize what was detected and list what you could not determine (license, badges, env-var docs, deployment) so the user can fill those <!-- TODO --> markers.

[!TIP] Generate the scripts table directly from the scripts object so it never drifts. If two scripts are obvious wrappers (build calling prebuild), document the public one and mention the dependency in a single line rather than listing internals.

Examples

For a detected Node/TypeScript project (package.json with name: "taskflow", a next dev style scripts block, and src/ + public/), the skill emits:

# taskflow

A task-board API and dashboard built with Next.js and TypeScript.

TaskFlow exposes a REST API for boards, lists, and cards, with a server-rendered
dashboard. State is persisted to Postgres via Prisma.

## Installation

```bash
pnpm install   # lockfile detected: pnpm-lock.yaml
```

## Usage

```bash
pnpm dev       # start the dev server on http://localhost:3000
```

## Scripts

| Script  | Command          | Description                       |
| ------- | ---------------- | --------------------------------- |
| `dev`   | `next dev`       | Run the dev server with HMR       |
| `build` | `next build`     | Production build                  |
| `start` | `next start`     | Serve the production build        |
| `lint`  | `eslint .`       | Lint with the flat ESLint config  |
| `test`  | `vitest run`     | Run the test suite once           |

## Project structure

```text
src/
  app/        Next.js App Router routes and layouts
  lib/        data access and shared utilities
  components/ shared UI components
public/       static assets served as-is
prisma/       schema and migrations
```

<!-- TODO: add license, CI badges, and DATABASE_URL setup notes -->

Every command above came from the project's real scripts; the tree lists only directories that exist. Fill the TODO marker before publishing.

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.