create-readme

作者: github

为项目生成结构专业、格式规范的完整README.md文件。通过分析整个项目工作区,创建上下文准确、组织清晰的文档。遵循成熟的开源README模式,包含清晰的设置、使用和关键功能章节。采用GitHub Flavored Markdown及警示语法,提升可读性与视觉层次。在细节与简洁间取得平衡,避免不必要的章节和过多表情符号,同时保持...

npx skills add https://github.com/github/awesome-copilot --skill create-readme

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