Скиллы/Документы/create-readme

create-readme

Создание README для проекта

github/awesome-copilotОт разработчика платформы

39 901звёзд 5 096форковУ всего репозитория

Что получите

Файл README.md без избыточных эмодзи и отдельных разделов о лицензии, участии в разработке или истории изменений.

Что передать

Проект и его рабочее окружение для изучения.

Автопроверка файлов09.10.2026

Проверен состав файлов. Запуск не тестировался. Что проверено

Оценки пользователей

Загрузка оценок…

Ваш опыт

Обсудить →

Как использовать

Помогает разработчикам подготовить понятное описание проекта после изучения его содержимого и рабочего окружения. Ориентируется на краткий, информативный текст с удобной структурой.

Передайте проект, для которого нужен README.
Изучите его содержимое и используйте предложенные образцы как ориентир для структуры и тона.
Оформите текст в Markdown для GitHub; если найден логотип или значок проекта, добавьте его в заголовок.

Пример запроса после установки

Изучи этот проект и создай краткий README для новых пользователей с понятной структурой, оформлением для GitHub и логотипом, если он есть.

Пример составлен по инструкции автора; результат запуска не проверялся.

Основание: инструкция закреплённой версии

Для установки

Передайте промпт агенту, поддерживающему этот скилл. Подключения и инструменты для работы скилла настраиваются отдельно.

Совместимые агенты

GitHub Copilot

Совместимость указана для инструкций. Запуск в каждом приложении не тестировался; для веб-чата способ подключения может отличаться.

Файлы скилла

GitHub

SKILL.md2 КБ

Читать инструкцию SKILL.md

Исходный текст закреплённой версии.

---
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.

Проверка и особенности

Автоматическая проверка источника и файлов

Автоматически проверены публичный репозиторий, лицензия, заголовок SKILL.md, состав текстового пакета и Git-хеш каждого файла. Пакеты с исполняемыми файлами и срабатываниями применённых статических правил не включены. Ручной аудит всех инструкций и функциональный запуск не проводились. Внешние инструменты и сервисы не проверялись. Проверка не гарантирует безопасность.

В публичном списке установок на 2026-10-09 у скилла было 18 714 установок. Порог отбора — 1 000 установок. Число установок показывает распространённость, а не качество или безопасность инструкции.

Есть ссылки на внешние инструкции или инструменты: их содержимое и доступность могут изменяться отдельно от скилла.

Проверка состава: 09.10.2026
Проверенная версия: 82701c24b994
Файлы с кодом: Не указаны в данных проверки
Изменения на GitHub: Нужна повторная проверкаПоследняя проверка: 11.10.2026

Как мы проверяем скиллы

Репозиторий и лицензия

github/awesome-copilot

39 901 звёзд5 096 форков

Это показатели всего репозитория, а не установки скилла. Снимок требует обновления.

Другие скиллы из этого репозитория

Последняя активность GitHub: 09.10.2026
Лицензия: MIT
Добавлен в каталог: 09.10.2026

Полный текст лицензии

MIT License

Copyright GitHub, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Ещё в этой категории

Все в категории

Обсуждение

Правила

Пользовались этим скиллом? Делитесь опытом без регистрации. Все комментарии проверяет модератор.

Мои комментарии