create-readme — скилл для GitHub Copilot: установка и работа
Скилл изучает проект и создаёт структурированный README.md. Подойдёт, когда документацию нужно собрать по коду и файлам проекта.
npx skills add github/awesome-copilot --skill create-readme -a claude-codeЧто делает create-readme
create-readme просматривает проект и рабочее пространство, затем создаёт README.md. Он формирует структуру документа, описывает проект в формате GFM и использует синтаксис GitHub admonitions там, где это уместно. Если в проекте есть логотип или иконка, скилл может добавить её в заголовок README.
В документ не включаются разделы LICENSE, CONTRIBUTING и CHANGELOG, потому что для них предусмотрены отдельные файлы. Текст должен оставаться кратким и не перегружаться эмодзи. Ставьте скилл, если README нужно подготовить по содержимому репозитория; для ручной документации с заранее заданной структурой он избыточен.
Какие задачи решает
- собрать README.md по содержимому проекта
- описать структуру репозитория в GFM
- добавить в README найденный логотип или иконку
- исключить из README разделы LICENSE и CHANGELOG
Примеры запросов агенту
- Создай README.md для этого проекта после полного просмотра рабочего пространства.
- Обнови README.md по текущему коду, используя GFM и GitHub admonitions там, где это уместно.
- Проверь проект и подготовь краткий README.md без разделов LICENSE, CONTRIBUTING и CHANGELOG.
Как установить create-readme
1Через Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill create-readme -a claude-code2Вручную: положить файлы
~/.claude/skills/create-readme/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/create-readme/
Вручную: положить файлы
.agents/skills/create-readme/SKILL.mdДля всех проектов — ~/.agents/skills/
Вручную: положить файлы
.cursor/skills/create-readme/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1Через Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill create-readme2GitHub CLI
gh skill install github/awesome-copilot create-readme3Вручную: положить файлы
.github/skills/create-readme/SKILL.mdКомандой платформы
gemini skills install https://github.com/github/awesome-copilot --path skills/create-readmeВручную: положить файлы
.devin/skills/create-readme/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
Похожие
Вопросы о create-readme
Как установить create-readme в GitHub Copilot?
Выполните npx skills add github/awesome-copilot --skill create-readme, затем используйте файл .github/skills/create-readme/SKILL.md.
Что делает create-readme?
Скилл просматривает проект и рабочее пространство, а затем создаёт структурированный README.md в формате GFM. Он также может использовать найденный логотип или иконку в заголовке.
Какие разделы create-readme не добавляет в README?
Скилл не включает разделы LICENSE, CONTRIBUTING и CHANGELOG. Для них предполагаются отдельные файлы.
Исходный текст
SKILL.md · MIT
--- name: create-readme description: 'Create a README.md file for the project' --- ## Role You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read. ## Task 1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project. 2. Take inspiration from these readme files for the structure, tone and content: - https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md - https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md - https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md - https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md 3. Do not overuse emojis, and keep the readme concise and to the point. 4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections. 5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate. 6. If you find a logo or icon for the project, use it in the readme's header.
© github · MIT · github/awesome-copilot
