kierangao/general-readme-skill
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
Создавайте профессиональные и красивые файлы README для любого проекта с использованием навыков AI Assistants.
Обзор
Общие навыки README Генерируют профессиональные файлы README для любого проекта с использованием помощников кодирования ИИ Zero Dependencies · Multi-Platform · Multi-Language · Поддерживает код Claude, Copilot, курсор и многое другое Соберите параметры конфигурации до генерации. Все опции имеют фиксированные значения по умолчанию. - (по умолчанию: английский) - (необязательно: китайский, японский, корейский, испанский, французский, русский и т.д.) Используйте встроенные инструменты для сканирования локального каталога проектов. Для типичного проекта Node.js с package.json: Загрузите справочные файлы, а затем сгенерируйте контент после перевернутой пирамиды. Все ссылки, расположенные в ссылках/папке: bash npm install my-package bash cp .env.example .env bash npm run dev'
Обзор (машинный перевод)
Общий навык чтения
Создание и обновление основанных на фактических данных файлов README с помощью помощников по кодированию ИИ
v2.0.0 · Подтверждение предпочтений · Обновления Git-Aware · Многоплатформенная · Многоязыковая
Английский язык · 中 · · блудный язык
Быстрый старт
Этот репозиторий предоставляет два навыка: readme-write создает файлы README и readme-update сохраняет их текущими от изменений Git. Основной рабочий процесс использует собственные средства чтения / поиска / редактирования агента. Дополнительные офлайн-шашки требуют Python 3.9+ и никаких сторонних пакетов.
###Установить readme-write
Скопируйте SKILL.md, references/ и scripts/ вместе в каталог навыков readme-write. Сохраняйте их относительные пути нетронутыми; установка только [Т7] оставляет рабочий процесс неполным.
Для другого целевого проекта используйте в качестве места назначения каталог абсолютных навыков этого проекта и не переписывайте существующие командные инструкции. См. руководства по интеграции: Claude Code, GitHub Copilot, Cursor. Они описывают размещение файлов; загрузка хоста должна быть проверена в установленном хосте.
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
General README Skill
Create and update evidence-based README files with AI coding assistants
v2.0.0 · Preference Confirmation · Git-Aware Updates · Multi-Platform · Multi-Language
English · 中文 · 日本語 · 한국어 · Русский
Quick Start
This repository (directory general-readme-skill) provides two skills: readme-write creates README files and readme-update keeps them current from Git changes. The core workflow uses native agent read/search/edit tools. The optional offline checkers need Python 3.9+ and no third-party packages.
Install readme-write
Copy SKILL.md, references/ and scripts/ together into a skill directory named readme-write. Keep their relative paths intact; installing only SKILL.md leaves the workflow incomplete.
mkdir -p .claude/skills/readme-write
cp SKILL.md .claude/skills/readme-write/
cp -r references/ scripts/ .claude/skills/readme-write/
For another target project, use that project’s absolute skill directory as the destination and do not overwrite existing team instructions. See the integration guides: Claude Code, GitHub Copilot, Cursor. They describe file placement; host loading must be verified in the installed host. Natural-language invocation is the portable option; /readme-write and /readme are trigger phrases, not guaranteed slash commands.
Get the first result
Ask the host agent:
Write a README for this project
The first response bundles the unresolved preferences and stops until you answer. Reply with your choices or “use the recommended settings”. After acceptance, the agent inspects static project evidence, writes the agreed README files, and reports what was checked.
To delegate choices explicitly:
Рекомендуемые инструменты
Попробуйте другой запрос или уберите фильтр.
Установка
npx skillfish add kierangao/general-readme-skill