# readme-generator

Скилл readme-generator генерирует README.md для проектов на Arduino, ESP32 и RP2040. Подходит, когда проект нужно документировать перед публикацией на GitHub.

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

## Что делает

Скилл создаёт README.md для maker-проектов на Arduino, ESP32 и RP2040. Он собирает описание проекта, аппаратные компоненты, библиотеки, установку, настройку, использование, устранение неполадок и инструкции для участников. Данные можно собрать в диалоге или извлечь из существующего проекта.

В комплекте есть скрипт `scripts/generate_readme.py`. Он поддерживает интерактивный режим, быструю генерацию по названию проекта и платы, а также сканирование каталога через `--scan`. Для запуска примеров нужен `uv`. Из кода скилл умеет извлекать назначения пинов из `config.h`, подключённые библиотеки и признаки WiFi, Bluetooth и типов сенсоров. Если в проекте нет `config.h`, назначения пинов автоматически не извлекутся.

## Требования
- Работает с: GitHub

## Установка

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

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

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add wedsamuel1230/embedded-engineering-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 wedsamuel1230/embedded-engineering-skills skills/readme-generator
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- составить README.md для Arduino-проекта
- описать аппаратные компоненты и соединения
- собрать список библиотек из кода
- подготовить инструкции для GitHub
- добавить разделы по настройке и устранению неполадок

## Примеры запросов агенту
- Составь README.md для моего проекта на ESP32 и включи разделы по железу, установке и настройке.
- Просканируй проект в `/path/to/arduino/project` и создай `README.md`.
- Сгенерируй README для проекта Weather Station на плате ESP32 в файл `README.md`.

## Похожие
- [create-readme](https://affpapa.org/nevibecode/skills/create-readme.md) — скилл · 19081 установка
- [readme-optimization](https://affpapa.org/nevibecode/skills/readme-optimization.md) — скилл · 13600 установок
- [beautify-github-readme](https://affpapa.org/nevibecode/skills/beautify-github-readme.md) — скилл · 1300 установок
- [animated-readme-logo](https://affpapa.org/nevibecode/skills/animated-readme-logo.md) — скилл · 2700 установок
- [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 · jeremylongshore](https://affpapa.org/nevibecode/skills/jeremy-longshore-readme-generator.md) — 273 установки
- [readme-generator · patricio0312rev](https://affpapa.org/nevibecode/skills/readme-generator.md) — 313 установок

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

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

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