doc-readme-gen

Community

Automatically generate or update READMEs.

AuthorCaptainPhantasy
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This tool automates the creation and maintenance of professional project READMEs, saving time and ensuring consistency across repositories.

Core Features & Use Cases

  • Generates standard README sections such as Title, Description, Installation, Usage, and License based on a structured frontmatter and templates.
  • Updates existing READMEs to reflect changes in project scope, dependencies, or installation steps.
  • Supports multi-project templates to enforce uniform documentation across teams.

Quick Start

Create or update a README.md in your project by running a documentation generation command with your project metadata.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-readme-gen
Download link: https://github.com/CaptainPhantasy/floyd-v5/archive/main.zip#doc-readme-gen

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.