# make-readme

Скилл make-readme сканирует проект, задаёт уточняющие вопросы и сразу собирает файл README.md с бейджами и нужной структурой.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 276 у репозитория
- Автор: Samarth Gupta
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/make-readme/SKILL.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/make-readme

## Что делает

Скилл начинает работу с поиска конфигурационных файлов в каталоге проекта. Он проверяет `package.json`, `pyproject.toml`, `Cargo.toml` и `go.mod`, чтобы автоматически определить название, версию и стек. Если в подпапках лежит от трёх плагинов с собственными манифестами, инструмент сразу переключается на структуру для коллекций плагинов.

Дальше агент запускает короткий опрос. На первом шаге вы выбираете тип проекта, язык, тип лицензии и глубину документации от минимальной до подробной. Для простых утилит генерация стартует сразу. Для крупных проектов скилл уточнит состав разделов: демонстрацию, конфигурацию, руководство для контрибьюторов и варианты бейджей.

Перед записью файла агент предупредит, если в папке уже есть старый `README.md`. Это защищает документацию от случайной перезаписи.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add gupsammy/Claudest
```
В чате агента (не в терминале):
```text
/plugin install claude-coding@Claudest
```
Команда ставит плагин claude-coding целиком, со всеми его скиллами

2. **Через Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill make-readme -a claude-code
```

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install gupsammy/Claudest plugins/claude-coding/skills/make-readme
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/make-readme
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

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

## Когда брать
- составить структуру `README.md` под конкретный тип проекта
- подобрать и встроить бейджи shields.io для репозитория
- собрать сводную таблицу компонентов для каталога плагинов
- оформить разделы с настройками и шагами контрибьютинга

## Примеры запросов агенту
- Сгенерируй README для этого проекта
- Напиши минимальный README с бейджами
- Создай документацию для нашей коллекции плагинов

## Похожие
- [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 установок
- [readme-generator](https://affpapa.org/nevibecode/skills/readme-generator.md) — скилл · 313 установок
- [make-documentation](https://affpapa.org/nevibecode/skills/make-documentation.md) — скилл · 1500 установок
- [readme-updater](https://affpapa.org/nevibecode/skills/readme-updater.md) — скилл · ★ 788 у репозитория

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

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