# readme-generator

Скилл для автоматической генерации README-файлов в проектах. Активируется по фразе «readme generator» или «readme» в запросе.

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

## Что делает

Скилл запускается автоматически, когда в запросе встречается упоминание readme generator или просто readme. Он даёт пошаговые инструкции по созданию README и генерирует готовые конфигурации, следуя типовым паттернам и практикам.

Внутри — правила для инструментов `Read`, `Write`, `Edit`, `Bash(cmd:*)` и `Grep`. Это значит, что скилл может читать файлы проекта, создавать и править README, а также выполнять команды в терминале.

Для работы нужно настроенное окружение разработки и доступ к нужным инструментам. Скилл входит в категорию DevOps Basics, поэтому базовое понимание devops-концепций не помешает. Автор — Jeremy Longshore, лицензия MIT.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --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 jeremylongshore/tons-of-skills-marketplace --skill readme-generator -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --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 jeremylongshore/tons-of-skills-marketplace skills/01-devops-basics/readme-generator
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/jeremylongshore/tons-of-skills-marketplace --path skills/01-devops-basics/readme-generator
```

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- сгенерировать README для нового проекта
- получить пошаговый план оформления README
- проверить README на соответствие типовым стандартам
- создать production-ready конфигурации для документации

## Примеры запросов агенту
- Помоги мне с readme generator для этого проекта
- Сгенерируй README по стандартным паттернам
- Проверь мой README на соответствие best practices

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

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

Из того же набора: [jeremylongshore/tons-of-skills-marketplace](https://affpapa.org/nevibecode/by/jeremylongshore/tons-of-skills-marketplace.md) — 139 карточек

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

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