# Readme Generator

> README Generator

- Skill: `comcclelland/readme-generator` (Agent Skill)
- Install (CLI): `npx skillmds@latest add comcclelland/readme-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/comcclelland/readme-generator/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: comcclelland (https://skillmd.com/u/comcclelland)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/comcclelland/readme-generator

---

# README Generator

Scans a project and generates a comprehensive README.

## When to Use

- When the user asks to "generate a README", "document this project", or "write project docs"
- When a project has no README or an outdated one

## Process

1. Scan the project structure:
   - Package files (package.json, requirements.txt, go.mod, etc.)
   - Source directories and entry points
   - Config files, CI/CD, Docker
   - Existing docs, LICENSE, CONTRIBUTING

2. Identify:
   - Project name and description (from package.json, pyproject.toml, etc.)
   - Tech stack and dependencies
   - How to install and run
   - How to test
   - Project structure

3. Generate README with these sections:

```markdown
# Project Name

One-line description.

## Features
- Key capabilities

## Prerequisites
- Required tools and versions

## Installation
Step-by-step setup instructions

## Usage
How to run, with examples

## Development
- How to build, test, lint
- Project structure overview

## Contributing
How to contribute (or link to CONTRIBUTING.md)

## License
License type (or link to LICENSE)
```

### Rules
- Only include sections that are relevant to the project
- Use actual commands from the project's scripts/config (don't guess)
- Keep it concise — link to detailed docs rather than embedding everything
- Match the project's existing tone and conventions
- If a README already exists, offer to update rather than replace