GitHub README Skill

🚀 一句话生成专业的 GitHub README，自动整理项目文档并推送

问题背景

开发者在上传 GitHub 时经常会遇到：

• 📝 不知道 README 该怎么写，格式混乱
• 🎨 每次都要从零开始，浪费时间
• 📋 不同项目风格不统一
• 🔧 写完还要手动整理目录结构

这个 skill 让你一句话生成专业的 README。

✨ 特性

• 🤖 一句话触发 - 说"写 README"、"上传 GitHub"自动激活
• 📝 模板化生成 - 参考 remote-dev 和 win-fix-skill 的专业风格
• 🎨 格式统一 - 徽章、目录结构、使用示例完整
• 📋 智能填充 - 自动读取项目信息填充内容
• 🔧 一键推送 - 生成后自动提交并推送到 GitHub

🛠️ 支持的 AI 工具

工具	支持状态
MiMo Code	✅ 完全支持
Claude Code	✅ 完全支持
Cursor	✅ 完全支持
OpenCode	✅ 完全支持
其他 AI 编码工具	✅ 通用兼容

📦 前置条件

• ✅ 安装 GitHub CLI（gh）
• ✅ 已登录 GitHub 账号

🚀 快速开始

1. 安装 Skill

告诉你的 Agent：

请帮我安装 github.com/mantuoluozk/github-readme-skill

或者手动克隆：

git clone https://github.com/mantuoluozk/github-readme-skill.git ~/.claude/skills/

2. 开始使用

直接对 Agent 说：

写 README

或

上传 GitHub

📝 README 模板结构

# 项目名

[徽章区域]

> 一句话介绍

## 问题背景
## ✨ 特性
## 🛠️ 支持的 AI 工具
## 📦 前置条件
## 🚀 快速开始
## 📁 目录结构
## 🔧 核心功能详解
## 💡 使用示例
## 🤝 贡献
## 📄 许可证

📁 项目结构

github-readme-skill/
├── README.md        # 本文件
├── SKILL.md         # 核心指南（AI 代理读取）
└── LICENSE          # MIT 许可证

💡 使用示例

示例 1：为新项目生成 README

用户说："帮我写个 README，这个项目是一个 AI 新闻发布工具"

Agent 自动执行：

1. 读取项目文件了解功能
2. 按模板生成 README
3. 保存到项目根目录
4. 提交并推送到 GitHub

示例 2：上传到 GitHub

用户说："把这个项目上传到 GitHub"

Agent 自动执行：

1. 检查是否已有 README，没有则生成
2. 初始化 git 仓库
3. 创建 GitHub 仓库
4. 提交并推送

🤝 贡献

欢迎贡献！请遵循以下步骤：

1. Fork 本仓库
2. 创建你的分支 (git checkout -b feature/AmazingFeature)
3. 提交你的更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 创建一个 Pull Request

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情

---

遇到问题？ 提交 Issue