modify: 说明文档

README.md

@@ -0,0 +1,39 @@
+# GitHub Copilot Agent 配置
+
+本目录包含 Chongming-Zenoh 项目的 **GitHub Copilot 自定义 Agent** 定义，用于在 VS Code 中使用 AI 辅助开发时提供项目专属的上下文和指导。
+
+---
+
+## 文件说明
+
+| 文件                 | 说明                                                              |
+| -------------------- | ----------------------------------------------------------------- |
+| `chongming.agent.md` | Chongming 项目的 Agent 定义文件，包含完整的项目架构知识和开发规范 |
+| `README.md`          | 本文件                                                            |
+
+---
+
+## Agent 功能
+
+`chongming.agent.md` 定义了名为 **chongming** 的 Copilot Agent 模式。激活后，AI 助手将获得以下项目专属知识：
+
+- 项目总体架构（FastAPI + Zenoh + Vue 3）
+- 核心数据流和启动流程
+- 添加 Worker 插件的完整开发工作流
+- 为现有插件添加 RPC 端点
+- 配置驱动路由的修改方法
+- 前端开发指导（Element Plus、Pinia、Vue Router）
+- TOML 配置字段速查
+- 常用命令和注意事项
+
+---
+
+## 使用方式
+
+在 VS Code 中，通过 Copilot Chat 选择 **chongming** Agent 模式，或在对话中提及项目相关问题时，AI 助手将自动使用该 Agent 提供的项目上下文进行回答。
+
+---
+
+## 维护
+
+当项目架构或开发规范发生变化时，同步更新 `chongming.agent.md` 文件以确保 AI 助手的指导始终保持准确。

chongming.agent.md

@@ -224,6 +224,38 @@ async def cleanup(worker_manager):
 uv pip install -e utils/<name>
 ```
 
+### 六、编写或更新项目文档 (README.md)
+
+项目根目录的 `README.md` 是项目的**主要入口文档**，涵盖项目简介、核心特性、快速上手、构建部署等关键信息。
+当出现以下情况时，应及时同步更新 README：
+
+- 新增或移除 Worker 插件
+- 修改项目目录结构或核心配置文件
+- 添加新的环境变量或配置项（如 config.toml 新增字段）
+- 构建流程或打包方式发生变化
+- 快速启动命令或依赖安装方式改变
+- 新增或更新外部依赖（特别是工具包）
+
+**推荐结构**（可参考当前 README 模板）：
+
+1. **项目名称与描述** – 一句话概括项目定位。
+2. **核心特性** – 列表展示主要功能亮点（如 FastAPI、Zenoh、动态路由、Worker 框架等）。
+3. **项目结构** – 使用树形图展示关键目录与文件的作用。
+4. **快速开始** – 包含依赖安装（推荐 `uv sync`）和启动服务（`uv run serve`）命令。
+5. **构建指南** – 说明 PyInstaller / Nuitka 的打包方式（`uv run build pyinstaller` 等）。
+6. **配置说明** – 指向 `config/` 目录或详细配置文档的链接。
+7. **开发指南** – 可链接到此 Skill（如 `./.agents/skills/chongming/SKILL.md`）供开发者深入阅读。
+
+**更新流程：**
+
+1. 直接在根目录编辑 `README.md`，保持 Markdown 语法规范。
+2. 验证所有代码示例和命令路径是否正确（可实际执行一次）。
+3. 若新增插件或工具包，在“项目结构”和“核心特性”中体现。
+4. 提交前使用本地预览工具（如 VS Code 的 Markdown 预览）检查排版与链接。
+5. 确保 README 与 `pyproject.toml` 中定义的脚本（`serve`、`gen_models`、`build`）保持一致。
+
+> **注意**：README 是项目对外展示的第一窗口，务必保持内容准确、清晰、与代码库同步更新。
+
 ## 核心约定与规范
 
 ### 命名约定