agentleFS
kool7kool7/claude-skills/skills/readme/SKILL.md

readme

Skill0 starsChanged 45 days agoMITView on GitHub

Smart README skill — detects project type and applies the right rules. For VS Code extensions: writes README.md as a Marketplace product page (no badges/contributing/license) and DEV.md as the developer guide. For all other projects: writes a full README.md with installation, contributing, license, etc. Use this as the default entry point for any README task.

32 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use favicon, build and 6 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.
  • cpiprintSkill

    favicon

    Generate favicons from a source image

    Also in 3 projects that use this

  • Microsoft AzureSkill

    build

    Build the TypeSpec Rust emitter from source. Run this after cloning the repo, after pulling changes, or when TypeScript source files have been modified.

    Also in 3 projects that use this

  • GitHubSkill

    refactor

    Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.

    Also in 3 projects that use this

  • BlockSkill

    plan

    Draft a TDD, PRD, or lightweight plan in the conversation without committing it.

    Also in 3 projects that use this

  • GoogleSkill

    prototype

    Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right, or explore what a UI should look like.

    Also in 3 projects that use this

  • SentrySkill

    commit

    Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 1 is distinctive, and 2 are 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.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run these in parallel:

    line 16
  2. Very specific:

    Read package.json (or pyproject.toml, Cargo.toml, go.mod — whichever exists)

    line 18
  3. Very specific:

    If package.json contains "engines": { "vscode": ...

    line 21

“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

Smart README — Detect and Write

You are the entry point for all README generation. Detect what kind of project this is, then follow the matching rules below.


Step 1 — Detect Project Type

Run these in parallel:

  • find $ARGUMENTS -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/out/*' -not -path '*/dist/*'
  • Read package.json (or pyproject.toml, Cargo.toml, go.mod — whichever exists)

Decision rule:

  • If package.json contains "engines": { "vscode": ... } → VS Code Extension path (see Section A below)
  • Otherwise → General Project path (see Section B below)

Tell the user which path you're taking before proceeding.


SECTION A — VS Code Extension

Delegate entirely to the extension-page skill. Tell the user:

"This is a VS Code extension — running /extension-page rules."

Then invoke the extension-page skill with the same path argument. Do not re-implement its logic here.


SECTION B — General Project

Delegate entirely to the generate-readme skill. Tell the user:

"This is a general project — running /generate-readme rules."

Then invoke the generate-readme skill with the same path argument. Do not re-implement its logic here.

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.