readme-generator

Generate README.md files from project structure and templates.

9|5|Updated Dec 19, 2025

One-click install

npx skills add https://github.com/Rehan-Ul-Haq/my-skills --skill readme-generator-rehan-ul-haq

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: readme-generator
Source: https://github.com/Rehan-Ul-Haq/my-skills/tree/main/4- skill-creator-enhanced/evaluations/skill-creator-comparison/results/scenario-1/creator-B/readme-generator
Command: npx skills add https://github.com/Rehan-Ul-Haq/my-skills --skill readme-generator-rehan-ul-haq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Generates polished README.md files tailored to project type, audience, and language, accelerating project onboarding and documentation quality.

Core Features & Use Cases

Analyzes project structure to extract key details
Produces standard README sections with templates
Adaptable for CLI, library, web app
Uses assets/templates for consistent style

Quick Start

Quick-start: Provide project description and run the generator with your project path.