create-readme
Генерирует комплексные файлы README.md для проектов с профессиональной структурой и форматированием. Анализирует всё рабочее пространство проекта для создания контекстуально точной, хорошо организованной документации. Следует проверенным шаблонам README с открытым исходным кодом, используя четкие разделы для настройки, использования и ключевых функций. Применяет синтаксис GitHub Flavored Markdown и предупреждений для улучшенной читаемости и визуальной иерархии. Сохраняет баланс между детализацией и краткостью, избегая ненужных разделов и чрезмерного использования эмодзи, сохраняя при этом...
npx skills add https://github.com/github/awesome-copilot --skill create-readmeRole
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
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- 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
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.