Skills
.Work. You
Rest

generate-readme

Community

Auto-generate a comprehensive repo README.

Software Engineering#documentation#markdown#analysis#readme#documentation-generation
AuthorLPdsgn
Version1.0.0
Installs0

System Documentation

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.

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: generate-readme
Download link: https://github.com/LPdsgn/claude-toolkit/archive/main.zip#generate-readme

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 223,000+ vetted skills library on demand.