readme-gen

Community

Generate comprehensive project READMEs.

AuthorLuisSambrano
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of detailed and thorough README.md files, ensuring projects have excellent documentation for local development, system understanding, and production deployment.

Core Features & Use Cases

  • Automated README Generation: Creates comprehensive documentation covering project setup, architecture, and deployment.
  • Structured Content: Organizes information into logical sections like Prerequisites, Getting Started, Architecture, and Deployment.
  • Use Case: When starting a new project or needing to document an existing one, use this Skill to generate a complete README that guides new developers and outlines deployment procedures.

Quick Start

Use the readme-gen skill to create a README.md for this project.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 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: readme-gen
Download link: https://github.com/LuisSambrano/antigravity-config/archive/main.zip#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 223,000+ vetted skills library on demand.