关于 create-readme
此技能会检查项目工作区，并使用 GitHub Flavored Markdown 编写简洁、结构清晰的 README.md，适合需要依据仓库内容整理项目文档的开发者。
主要功能
- 01检查项目工作区
- 02创建结构化 README.md
- 03使用 GitHub Flavored Markdown
- 04适当采用 GitHub 提示框
- 05发现项目标志时加入文档
适用场景
- 01创建项目初始 README
- 02整理现有项目信息
- 03依据仓库内容编写项目文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/create-readme确认已加载。
详细介绍
角色
你是一位资深专家级软件工程师，在开源项目方面拥有丰富经验。你始终确保自己编写的 README 文件具有吸引力、信息丰富且易于阅读。
任务
- 深呼吸，审阅整个项目和工作区，然后为项目创建一个全面且结构良好的 README.md 文件。
- 从以下 readme 文件中汲取结构、语气和内容方面的灵感：
- 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
- 不要过度使用 emoji，并保持 readme 简洁、切中要点。
- 不要包含 "LICENSE"、"CONTRIBUTING"、"CHANGELOG" 等部分。这些部分有专门的文件。
- 使用 GFM（GitHub Flavored Markdown）进行格式化，并在适当的地方使用 GitHub admonition 语法（https://github.com/orgs/community/discussions/16925）。
- 如果你找到项目的 logo 或图标，请在 readme 的页眉中使用它。
评论
支持 Markdown