How do I install the Readme Generator skill?

Run npx skillmds@latest add sourav15mukherjee/readme-generator in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readme Generator safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readme Generator?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readme Generator free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readme Generator?

sourav15mukherjee (@sourav15mukherjee) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readme Generator by sourav15mukherjee

Name: Readme Generator
Rating: 4.2 (5 reviews)
Author: sourav15mukherjee

Readme Generator

Analyze project structure and generate a comprehensive README.md. Use when the user asks to create a README, generate documentation, write project docs, or wants a README for their repo. Scans the codebase and produces a polished README with all standard sections.

File contents

README Generator

Analyze a project's structure, tech stack, and code to generate a comprehensive, well-organized README.md.

Workflow

Scan the project structure
```
find . -maxdepth 3 -not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/dist/*" | head -80
```
Identify the project type: Library, CLI Tool, Web Application, API Service, or Monorepo.
Detect the tech stack Read config files (package.json, tsconfig.json, pyproject.toml, go.mod, Cargo.toml, Dockerfile). Extract: language, framework, test runner, linter, bundler, deployment target.
Identify key entry points and exports Read main source files to understand what the project does — exported functions, CLI commands, API endpoints.
Extract existing documentation hints Look for JSDoc/docstrings, existing partial README, CHANGELOG, LICENSE, CONTRIBUTING.
Generate the README with these sections:
- Title and Badges (license, language, version, CI status)
- Description (2-3 sentences)
- Features (bulleted key capabilities)
- Prerequisites (runtime versions, required accounts)
- Installation (actual commands from package.json scripts)
- Configuration (environment variables, config files)
- Usage (real code examples matching the actual API)
- API Reference (if applicable — table of endpoints/functions)
- Project Structure (key directories tree)
- Scripts (table of npm/make commands)
- Contributing (dev setup, testing, PR process)
- License (type with link)
Write the README If a README exists, ask to replace or merge.

Rules

Always read actual source code — never guess at what the project does
Match README complexity to project size
Use real values (actual script names, actual dependencies, actual ports)
Include working code examples that reflect the actual API
If no tests exist, suggest adding them in Contributing
Keep tone professional but approachable
Do not include irrelevant sections (no API Reference for a CLI tool)

---name: readme-generatordescription: Analyze project structure and generate a comprehensive README.md. Use when the user asks to create a README, generate documentation, write project docs, or wants a README for their repo. Scans the codebase and produces a polished README with all standard sections.---## README GeneratorAnalyze a project's structure, tech stack, and code to generate a comprehensive, well-organized README.md.## Workflow1. **Scan the project structure** ```bash find . -maxdepth 3 -not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/dist/*" | head -80 ``` Identify the project type: Library, CLI Tool, Web Application, API Service, or Monorepo.2. **Detect the tech stack** Read config files (`package.json`, `tsconfig.json`, `pyproject.toml`, `go.mod`, `Cargo.toml`, `Dockerfile`). Extract: language, framework, test runner, linter, bundler, deployment target.3. **Identify key entry points and exports** Read main source files to understand what the project does — exported functions, CLI commands, API endpoints.4. **Extract existing documentation hints** Look for JSDoc/docstrings, existing partial README, CHANGELOG, LICENSE, CONTRIBUTING.5. **Generate the README** with these sections: - **Title and Badges** (license, language, version, CI status) - **Description** (2-3 sentences) - **Features** (bulleted key capabilities) - **Prerequisites** (runtime versions, required accounts) - **Installation** (actual commands from package.json scripts) - **Configuration** (environment variables, config files) - **Usage** (real code examples matching the actual API) - **API Reference** (if applicable — table of endpoints/functions) - **Project Structure** (key directories tree) - **Scripts** (table of npm/make commands) - **Contributing** (dev setup, testing, PR process) - **License** (type with link)6. **Write the README** If a README exists, ask to replace or merge.## Rules- Always read actual source code — never guess at what the project does- Match README complexity to project size- Use real values (actual script names, actual dependencies, actual ports)- Include working code examples that reflect the actual API- If no tests exist, suggest adding them in Contributing- Keep tone professional but approachable- Do not include irrelevant sections (no API Reference for a CLI tool)

Frequently asked questions