Readme Generator

Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.

Install
cmdop skills install agensi-readme-generator

Readme Generator is a skill that produces a structured README.md by reading what is actually present in a repository rather than filling in generic boilerplate. It scans the directory structure, package files, configuration files, and declared dependencies to assemble a document that includes a project description, installation instructions, usage examples, a tech stack overview, and contribution guidelines.

Because the output is derived from the real contents of the project, the generated README reflects the actual tooling and setup rather than placeholder text. The skill is intended as a starting point: the result is an accurate first draft that still benefits from human review and editing before being published. It removes the friction of starting from a blank file by providing a context-aware foundation that covers the standard sections developers expect in a well-structured README.

This skill carries no tools list and no environment variable requirements according to its registry record. It is suited to projects where the structure and package metadata are already in place, since those files are what the skill reads to build its output. It is not a substitute for manual documentation of complex architectural decisions, API contracts, or domain-specific context that cannot be inferred from directory contents alone.

Use cases

  • Generate an initial README.md for a new project before publishing to a code host
  • Reconstruct missing or outdated README files in existing repositories by re-scanning current project state
  • Automate documentation bootstrapping in CI or developer tooling pipelines
  • Produce a tech stack section populated from actual package and dependency files
  • Create installation and usage sections derived from real project configuration

When to use it

  • When a repository lacks a README and needs an accurate starting draft quickly
  • When an existing README is outdated and a re-scan of current project files would produce a better baseline
  • When automating project scaffolding and documentation should be generated alongside code

When not to use it

  • When the project has no package files, configuration files, or structured directory layout for the skill to read from
  • When the goal is to document architectural decisions or domain context that cannot be inferred from file structure alone
  • When a fully finished, publication-ready README is required without any human editing step
  • When the project is not file-system accessible to the skill at runtime