📝 GitHub 仓库说明一键规范 → 让人一眼看懂你的 Skill

起仓库名 · 写 README · 一句话安装提示词 · 脱敏检查 · 发布 · 持续更新

一个给 Codex / Claude Code 用的 skill。说一句「把这个 skill 上传到 GitHub」，它就按固定格式起名、写说明、发布。

免责声明： 本 skill 只规范仓库说明的写法和发布步骤。发布前请自己确认仓库里没有密钥、个人信息和无权分发的素材。

📖 项目简介

能帮谁

• 自己做了 skill 想分享的人：会用 AI 做工具，但不知道仓库说明该怎么写
• 要把工具交给同事/客户的人：希望对方复制一句话就能装好，不用远程教
• 有好几个仓库的人：想让所有仓库说明风格统一、看起来专业

解决什么问题

以前	现在
仓库名是内部代号，别人看不懂	英文短词 + 中文「动作 → 结果」标题
README 想到哪写到哪	固定 11 节结构，照 MediaCrawler 的写法
安装要写「拷到 D 盘某文件夹」	一句话安装提示词，发给 AI 就能装
不小心把 key、本机路径传上去	发布前自动扫敏感信息
改了功能忘了更新说明	每次改进都同步 README 并 push

🔧 原理

纯提示词 skill：AI 读 SKILL.md 里的命名规则、README 模板、写作规则和发布步骤，用 git + gh 完成建仓库、加标签、推送。不需要额外安装任何东西。

✨ 功能特性

环节	功能	状态
起名	仓库名、中文标题、skill name/description 统一	✅
说明	11 节固定 README 结构，带徽章和表格	✅
安装	生成可直接复制的一句话安装提示词	✅
安全	发布前扫 key / token / 本机路径	✅
发布	建仓库、写简介、加 topic 标签、改名同步	✅
维护	每次改进自动 commit + push，同步功能表	✅

🚀 快速开始

💡 如果这个项目对你有帮助，请给个 ⭐ Star 支持一下！

方式一：一句话安装（推荐）

把这段话发给 Codex 或 Claude Code：

帮我安装这个 skill：https://github.com/caodoris471/github-skill-readme
把它 git clone 到你的 skills 目录（Codex 是 ~/.codex/skills，Claude Code 是 ~/.claude/skills），文件夹名 GitHub仓库说明-github-skill-readme。

装完之后，做好任何 skill 时说：

用 github-skill-readme 把这个 skill 上传到我的 GitHub

方式二：手动安装

git clone https://github.com/caodoris471/github-skill-readme "$HOME\.codex\skills\GitHub仓库说明-github-skill-readme"

Claude Code 用户把路径换成 $HOME\.claude\skills\GitHub仓库说明-github-skill-readme。国内连不上 GitHub 先开代理。

📋 用到的软件和 Skill

类别	名称	用途	安装
运行环境	git	提交和推送	winget install Git.Git
运行环境	GitHub CLI (gh)	建仓库、改名、加标签	winget install GitHub.cli，再 gh auth login
AI	Codex 或 Claude Code	读 skill、执行发布	自备

⚙️ 需要换成你自己的

位置	内容	填什么
一句话安装提示词	仓库地址	你自己的 github.com/<用户名>/<仓库名>
推送代理（可选）	https_proxy	你本机代理端口，不需要代理就不设

🗺️ 完整流程

#	节点	做什么
1	起名	定仓库名、中文标题，统一 skill 的 name 和 description
2	写 README	按 11 节模板写，面向第一次见到仓库的陌生人
3	脱敏	扫 key、token、本机路径、内部 ID
4	发布	gh repo create + 简介 + topic 标签
5	维护	每次改进 commit + push，同步功能表和常见问题

详细规则见 SKILL.md。样板仓库：viral-video-remix。

❓ 常见问题

• push 卡住或超时：国内网络先设代理 $env:https_proxy="http://127.0.0.1:端口"
• gh 报未登录：运行 gh auth login
• 没有赞助商怎么写：不写「赞助商」，用「⭐ 支持项目」放 Star 和 Issue 链接
• 改了仓库名旧链接还能用吗：能，GitHub 会自动跳转；本地记得 git remote set-url

⭐ 支持项目

觉得有用就点个 Star；有更好的写法欢迎提 Issue。

🙏 致谢

README 结构参考 MediaCrawler · 徽章来自 shields.io

📄 许可

MIT