agentsclimarketplace
Sign in

Generate readme

Skill prathakmalik/agent-standards-kit/skills/generate-readme

Generates or refreshes a repository's README.md by scanning the codebase for its purpose, structure, entry points, setup steps, and key workflows. Use when a repo has no README, a stub README, or the README is stale after significant changes. Trigger phrases: "generate the readme", "refresh the readme", "write a readme for this repo".From its SKILL.md

Install
npx -y skills add prathakmalik/agent-standards-kit --skill generate-readme

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.8 KB, 357 tokens by cl100k_base, as published. Nobody here has run it

generate-readme

Produce a clear, human-facing README.md grounded in what the code actually does — not a generic template.

When to use

  • New repo with no or stub README.
  • After architecture changes (new entry points, services, commands, config).
  • When onboarding notes are out of date.

Process

  1. Scan for signal (do not guess):
    • Manifest / build files (package.json, pyproject.toml, pom.xml, go.mod, Cargo.toml, etc.) for name, scripts, deps.
    • Entry points, CLI commands, exported modules.
    • Config and environment files (redact secret values; list the keys).
    • Existing docs, comments, and tests for intent.
  2. Draft these sections (skip any that don't apply):
    • One-line description (what + who it's for).
    • Quick start (install -> run -> verify), copy-paste, minimal.
    • Key concepts / architecture (a diagram if the structure is non-trivial).
    • Configuration (keys, not secret values).
    • How to contribute / run tests.
  3. Add a diagram when structure is non-trivial. Prefer a Mermaid flowchart or sequenceDiagram. Keep node names free of spaces.
  4. Write the file and summarize what you inferred so the human can correct it.

Rules

  • Ground every claim in something you found in the repo. If unsure, ask or mark it TODO.
  • Never paste secret values. List config keys only.
  • Match the project's existing tone if one exists.
  • Keep the quick start truly runnable — no assumed globals.

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.