agentleFS
sharklandysharklandy/claude-code-starter-kit/skills/process/readme-generator/SKILL.md

readme-generator

Skill0 starsChanged 4 months agoMITView on GitHub

Generate or incrementally update a project's README.md from an analysis of its structure, dependencies, scripts, tests and CI. Trigger whenever asked to write, generate, or update a README.

  • Installs packages

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

Files
SKILL.md
<!-- Skill générique de la "vague 2" -->

Générer ou mettre à jour un README (générique)

  1. Détecter si un README.md existe déjà.
    • S'il existe et contient déjà du contenu substantiel, proposer une mise à jour incrémentale (ajouter/corriger les sections obsolètes ou manquantes) plutôt qu'un remplacement complet par défaut. Ne remplacer entièrement que si l'utilisateur le demande explicitement ou si le fichier existant est un simple stub vide de scaffolding.
    • S'il n'existe pas, en générer un nouveau à partir des sections ci-dessous.
  2. Analyser le projet avant de rédiger :
    • Nom et description : déduits du manifeste (package.json, pyproject.toml, Cargo.toml...) ou du nom du dépôt si absent.
    • Installation : commande d'installation des dépendances détectée (npm install, pip install -r requirements.txt, cargo build...).
    • Usage : scripts disponibles dans le manifeste (scripts de package.json, cibles de Makefile...), avec un exemple d'appel pour chacun des plus utilisés (démarrage, build, test).
    • Structure du projet : dossiers de premier niveau significatifs, avec une phrase par dossier plutôt qu'un simple arbre de fichiers brut.
    • Tests et CI : commande de test détectée, et présence d'une CI (.github/workflows/, .gitlab-ci.yml...) à mentionner si elle existe.
    • Contribution : renvoyer vers un CONTRIBUTING.md existant s'il y en a un, sinon proposer une section minimale.
    • Licence : détectée depuis un fichier LICENSE existant si présent.
  3. S'adapter à ce qui existe déjà plutôt que d'imposer un template rigide : si le projet a des sections déjà présentes qui ne correspondent pas exactement à la liste ci-dessus (ex. une section "Architecture" ou "FAQ" spécifique au projet), les conserver plutôt que de les supprimer pour se conformer strictement au gabarit.
  4. Ne jamais affirmer qu'une commande "fonctionne" ou qu'un test "passe" sans l'avoir réellement vérifié dans cette session — décrire ce que fait la commande d'après le manifeste, pas un résultat non observé.

Gotchas

  • Un projet avec plusieurs manifestes (monorepo avec un package.json par package) ne doit pas être résumé uniquement à partir du manifeste racine — vérifier s'il existe une structure de sous-projets à refléter dans la section "Structure du projet".
  • Un README.md existant peut contenir des instructions d'installation déjà obsolètes par rapport au manifeste actuel (dépendance renommée, commande de script renommée) — comparer explicitement le contenu existant à l'état réel du manifeste avant de le considérer à jour.
  • Les sections d'un README existant qui ne se déduisent pas du code (badges, liens vers une doc externe, mentions légales ou de licence commerciale) doivent être préservées telles quelles lors d'une régénération — les recenser avant de générer, sous peine de les détruire silencieusement.

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.