docs: 更新 README 以反映最新的技能目录结构和仓库地址

2026-01-21 15:56:51 +08:00
parent dffa3fae12
commit 26c333dc84
1 changed files with 42 additions and 56 deletions
--- a/README.md
+++ b/README.md
@@ -1,64 +1,50 @@
 # OpenCode

-## 目录
+基于交互式 CLI 智能体的开发辅助系统。
+
+## 核心特性
+
+- **工作流驱动**：通过结构化的技能文档（Skills）指导 AI 执行复杂任务。
+- **项目规范集成**：针对不同语言（Go, Android, iOS 等）提供最佳实践指南。
+- **Git 自动化**：一键完成分析、提交、版本管理与推送。
+- **Gitea 集成**：完整的仓库管理与 Actions Runner 运维能力。
+
+## 目录结构

 ```
 opencode/
-├── command/                          # CLI 命令定义
-│   ├── git-commit.md                # 自动生成提交信息并提交
-│   ├── git-pull.md                  # 拉取远程最新变更
-│   ├── git-push.md                  # 提交+创建标签+推送（一键完成）
-│   ├── git-push-tags.md             # 推送所有标签到远程
-│   ├── gitea-config.md              # 查看 Gitea 配置和 Runner 状态
-│   ├── gitea-create-repo.md         # 在 Gitea 创建新仓库
-│   ├── gitea-create-runner.md       # 创建并启动 Gitea Actions Runner
-│   ├── gitea-delete-runner.md       # 删除已配置的 Runner
-│   ├── gitea-list-runners.md        # 列出所有已配置的 Runners
-│   ├── gitea-reset.md               # 重置 Gitea 配置
-│   ├── gitea-switch-org.md          # 切换默认组织
-│   └── review.md                    # 代码审查命令
+├── skill/                            # 结构化技能库与工作流说明
+│   ├── git/                         # Git 工作流 (Commit, Push, Tags)
+│   ├── gitea/                       # Gitea 平台集成与 Runner 管理
+│   ├── android/                     # Android 开发规范
+│   ├── ios/                         # iOS 开发规范
+│   ├── go/                          # Go 后端开发规范
+│   ├── electron/                    # Electron 桌面开发规范
+│   ├── agent-browser/               # 浏览器自动化技能
+│   ├── emqx/                        # MQTT/EMQX 运维指南
+│   └── opencode/                    # 平台自身维护 (Command/Skill 创建)
 │
-├── skill/                            # 可复用技能库和指南
-│   ├── git/                         # Git 工作流程和版本管理
-│   │   ├── SKILL.md                # 完整的 Git 工作流程指南
-│   │   └── quick-reference.md       # Git 快速参考
-│   │
-│   ├── gitea/                       # Gitea 平台集成
-│   │   ├── SKILL.md                # Gitea 完整指南
-│   │   ├── setup-guide.md          # 初始化和配置指南
-│   │   ├── repository-operations.md # 仓库操作指南
-│   │   ├── runner-management.md    # Runner 管理指南
-│   │   ├── api-reference.md        # Gitea API 参考
-│   │   ├── troubleshooting.md      # 常见问题和解决方案
-│   │   ├── workflow-generator.md   # Workflow 自动生成工具
-│   │   └── workflow-templates/     # CI/CD Workflow 模板库
-│   │       ├── android-app.md      # Android App 构建 Workflow
-│   │       ├── go-backend.md       # Go 后端服务 Workflow
-│   │       ├── nodejs-frontend.md  # Node.js 前端 Workflow
-│   │       └── wechat-miniprogram.md # 微信小程序 Workflow
-│   │
-│   ├── android-developer/           # Android 开发指南
-│   │   └── SKILL.md                # Android 项目开发规范
-│   │
-│   ├── ios-developer/               # iOS 开发指南
-│   │   └── SKILL.md                # iOS 项目开发规范
-│   │
-│   ├── go-developer/                # Go 后端开发指南
-│   │   └── SKILL.md                # Go 项目开发规范
-│   │
-│   ├── electron-developer/          # Electron 桌面应用指南
-│   │   └── SKILL.md                # Electron 项目开发规范
-│   │
-│   └── mqtts-developer/             # MQTT over TLS/SSL 开发指南
-│       ├── SKILL.md                # MQTT 完整指南
-│       ├── README.md               # MQTT 项目说明
-│       ├── setup-mqtts-acme.md     # ACME 证书配置
-│       ├── mqtts-client-config.md  # 客户端配置
-│       ├── mqtts-quick-reference.md # 快速参考
-│       └── USAGE_EXAMPLES.md       # 使用示例
-│
-├── README.md                        # 项目说明文档（当前文件）
-├── AGENTS.md                        # 全局开发规范和指南
+├── AGENTS.md                        # 全局通用规则与提示词约束
 ├── opencode.json                    # 项目配置文件
-└── .gitignore                       # Git 忽略文件配置
+├── package.json                     # 依赖与元数据
+└── LICENSE                          # MIT 许可证
 ```
+
+## 如何使用技能 (Skills)
+
+在与 OpenCode 对话时，可以通过 `@skill` 语法直接引用对应的工作流：
+
+- **Git 推送**：`@skill/git/push-workflow.md 执行`
+- **创建 Gitea Runner**：`@skill/gitea/create-runner.md 帮我创建一个名为 my-runner 的 runner`
+- **遵循项目规范**：`@skill/go/SKILL.md 帮我重构这个 API 接口`
+
+## 开发规范
+
+本项目严格遵循 [AGENTS.md](./AGENTS.md) 中定义的全局规则：
+- 必须使用**中文**进行交互。
+- 严禁未经授权的自动 Git 提交操作（除非用户明确要求）。
+- 优先保持回复简洁高效，减少 Token 消耗。
+
+## 仓库地址
+
+[https://git.shigongcao.com/ai/opencode.git](https://git.shigongcao.com/ai/opencode.git)