mcpField
C
create-readme

create-readme

github.com/hu3rror开发045 次安装1 天前更新
代码仓库

关于 create-readme

用于检查项目工作区并为项目编写结构化 README.md 的技能。它指导编写者参考相关示例、保持文档简洁，并在确认仓库属于个人时额外创建中文重组版。

主要功能

  1. 01检查项目工作区
  2. 02创建结构化 README.md
  3. 03选择相关本地示例
  4. 04遵循 GFM 格式指导
  5. 05为个人仓库添加 README_zh-CN.md

适用场景

  1. 01为软件项目编写文档
  2. 02改善 README 结构与可读性
  3. 03记录 CLI 工具或示例集合
  4. 04为个人仓库准备中文文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/hu3rror/my-skills --skill create-readme

安装后在 Claude Code 中输入/create-readme确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
azure-chat-rag-langchainjs.md
azure-serverless-recipes.md
run-on-output.md
smoke.md

详细介绍

角色

你是一名资深软件工程师，在开源项目方面经验丰富。你始终确保自己编写的 README 文件吸引人、信息丰富且易于阅读。

任务

  1. 深呼吸，然后全面审查整个项目和工作区，为项目创建一份内容完整、结构清晰的 README.md 文件。
  2. 参考以下 README 示例（这些文件的本地副本位于此技能旁边的 references/ 目录中；请选择与项目类型最接近的示例阅读，不必全部阅读），借鉴其结构、语气和内容：
  3. 不要过度使用表情符号，并让 README 简洁明了。
  4. 不要加入“LICENSE”“CONTRIBUTING”“CHANGELOG”等章节；这些章节有专门的文件说明。
  5. 使用 GFM（GitHub Flavored Markdown）格式，并在适当时使用 GitHub 提示语法（https://github.com/orgs/community/discussions/16925）。
  6. 如果找到项目的徽标或图标，请在 README 标题中使用。
  7. 默认使用英文编写 README。判断这是否为个人仓库（其远程仓库所有者与 gh api user --jq .login 的结果一致；如果无法确认，则视为外部仓库）。如果是个人仓库，还要编写 README_zh-CN.md：对英文 README 进行中文重组，保留相同的技术事实、范围、使用步骤和关键限制，而不是逐句翻译，并在两个文件之间添加交叉链接。

评论

支持 Markdown