skills.rest
LPdsgn
LPdsgnCOMMUNITY
Explore all skills by this author →
GitHub

generate-readme

Analyze repository documentation to generate a structured Markdown README.

Updated Aug 27, 2026
Search Tags:#documentation#markdown#analysis#readme#documentation-generation
One-click install
npx skills add https://github.com/LPdsgn/claude-toolkit --skill generate-readme-lpdsgn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-readme
Source: https://github.com/LPdsgn/claude-toolkit/tree/main/plugins/workflow-tools/skills/generate-readme
Command: npx skills add https://github.com/LPdsgn/claude-toolkit --skill generate-readme-lpdsgn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of a clear, publish-ready repository README by analyzing existing project documentation structures and conventions.

Core Features & Use Cases

  • Documentation discovery: Scans project documents such as CLAUDE.md, .claude/rules, docs/, and specs to collect relevant details.
  • Structured output: Generates a well-organized README with sections for Project Name, Technology Stack, Architecture, Getting Started, Project Structure, Key Features, Development Workflow, Coding Standards, Testing, Contributing, and License.
  • Developer-focused guidance: Produces cross-referenced content and practical instructions to help new contributors start quickly.

Quick Start

Run the skill to generate the README.md at the specified output path for the current repository.

Frequently Asked Questions about generate-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a README from existing project documentation?▼

To auto-generate a README from existing project documentation, this Skill scans sources like CLAUDE.md, .claude/rules, docs/, and specs/ to assemble a formatted Markdown document with sections for technology stack, architecture, and development workflow.

What is the best way to create a comprehensive repository README from scattered docs?▼

The best way to create a comprehensive repository README from scattered docs is to analyze project documentation structures and conventions, leveraging available metadata and frontmatter to output a cohesive, publish-ready project overview.

Can I generate a README with sections for coding standards and testing references?▼

Yes, you can generate a README with sections for coding standards and testing references. The Skill produces a structured Markdown document including sections for Development Workflow, Coding Standards, Testing, and Contributing.

Does the README generation work with CLAUDE.md and specs directories?▼

Yes, README generation works with CLAUDE.md and specs directories. The Skill explicitly scans CLAUDE.md, .claude/rules, docs/, and specs/ to discover relevant project details and collect information for the final output.

What file format does the generated README use?▼

The generated README uses a formatted Markdown file format. It outputs a structured Markdown document complete with sections and cross-references suitable for publishing directly to a repository.

How to ensure new contributors start quickly using a generated project overview?▼

To ensure new contributors start quickly using a generated project overview, the Skill produces cross-referenced content and practical instructions within the README, covering Getting Started, Project Structure, and Key Features sections.

Related Skills

Explore More Software Engineering Skills→
solatissolatis
898

doc-sync

Synchronize CLAUDE.md navigation indexes and README.md architecture docs across a repository.

Community
Advanced
christopheryeochristopheryeo

new-product

Generate six-section product white papers from Google Drive documentation.

Community
Advanced
JuniYadiJuniYadi

codebase-analyzer

Analyze codebases to identify tech stack, architecture, and integration touchpoints.

Community
Intermediate
clawpod-appclawpod-app
46

kb-article

Draft structured knowledge base articles from resolved support issues.

Community
Intermediate