# readme-generator

Скилл readme-generator создаёт структурированный README.md с бейджами, шагами установки, таблицами API и правилами контрибьютинга. Пригодится при оформлении новых репозиториев.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 313 установок · ★ 64 у репозитория
- Автор: patricio0312rev
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/patricio0312rev/skills/tree/HEAD/foundation/readme-generator/SKILL.md
- Обновлён: 2026-01-12
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/readme-generator

## Что делает

Скилл сначала разбирает репозиторий. Затем он собирает файл документации по шагам: описывает назначение проекта, расставляет щиты Shields.io, указывает команды установки для npm, pnpm или yarn и приводит примеры импорта.

Внутрь попадают таблицы переменных окружения, параметры вызова API, схема каталогов и правила коммитов по стандарту Conventional Commits. Заготовлен также блок с ответами на частые вопросы и разбором типичных ошибок.

Шаблон явно ориентирован на стек Node.js и TypeScript с примерами для React. Если в коде нет отдельного клиента API или переменных окружения, сгенерированные секции придётся удалять руками.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill readme-generator -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/readme-generator/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/readme-generator/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill readme-generator -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/readme-generator/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill readme-generator -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/readme-generator/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install patricio0312rev/skills foundation/readme-generator/SKILL.md
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/readme-generator/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill readme-generator -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/patricio0312rev/skills --path foundation/readme-generator
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/readme-generator/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill readme-generator -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/patricio0312rev/skills/tree/HEAD/foundation/readme-generator/SKILL.md

## Когда брать
- оформить файл README.md для нового Node.js- или TypeScript-репозитория
- составить таблицы переменных окружения и параметров методов API
- добавить правила оформления коммитов по стандарту Conventional Commits
- разместить бейджи сборки, версии пакета и лицензии проекта

## Примеры запросов агенту
- Сгенерируй README для этого проекта
- Составь project setup docs и документацию к API
- Сделай readme template с инструкциями по установке

## Похожие
- [readme-blueprint-generator](https://affpapa.org/nevibecode/skills/readme-blueprint-generator.md) — скилл · 9662 установки
- [update-readme](https://affpapa.org/nevibecode/skills/update-readme.md) — скилл · ★ 276 у репозитория
- [indexion-readme](https://affpapa.org/nevibecode/skills/indexion-readme.md) — скилл · 5100 установок
- [create-readme-section](https://affpapa.org/nevibecode/commands/create-readme-section.md) — команда · ★ 2744 у репозитория
- [create-readme](https://affpapa.org/nevibecode/skills/create-readme.md) — скилл · 19081 установка
- [readme-optimization](https://affpapa.org/nevibecode/skills/readme-optimization.md) — скилл · 13600 установок

## Другие версии с тем же именем
- [readme-generator · jeremylongshore](https://affpapa.org/nevibecode/skills/jeremy-longshore-readme-generator.md) — 273 установки
- [readme-generator · wedsamuel1230](https://affpapa.org/nevibecode/skills/wedsamuel1230-readme-generator.md) — 147 установок

Из того же набора: [patricio0312rev/skills](https://affpapa.org/nevibecode/by/patricio0312rev/skills.md) — 148 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
