C
create-readme
by @githubv1.0.0
4.0(0)
为项目创建README.md文件,提供项目概述、安装和使用说明。
安装方式
npx skills add github/awesome-copilot --skill create-readmecompare_arrows
Before / After 效果对比
1 组使用前
手动编写README文件耗时且容易遗漏关键信息,导致项目说明不完整。新用户或协作者难以快速上手,增加沟通成本。
使用后
自动化生成包含项目概述、安装和使用说明的README文件,确保信息全面准确。显著提升了项目文档质量和团队协作效率。
description 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
- 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.
forum用户评价 (0)
发表评价
效果
易用性
文档
兼容性
暂无评价,来写第一条吧
统计数据
安装量7.5K
评分4.0 / 5.0
版本1.0.0
更新日期2026年3月16日
对比案例1 组
用户评分
4.0(0)
5
0%
4
0%
3
0%
2
0%
1
0%
为此 Skill 评分
0.0
兼容平台
🔧Claude Code
🔧OpenClaw
🔧OpenCode
🔧Codex
🔧Gemini CLI
🔧GitHub Copilot
🔧Amp
🔧Kimi CLI
时间线
创建2026年3月16日
最后更新2026年3月16日