'补充说明文档'

Author: mmclouds

README.md

@@ -3,16 +3,15 @@
 这是一个用于自动同步 Gitee 仓库到 GitHub 的工具，基于 GitHub Actions 实现。支持多仓库同步、分支指定、仓库可见性控制等功能。
 
 ## 功能特点
-
 - 🔄 支持多个仓库同步
 - 🕒 可配置的同步时间（默认东八区 14:00, 22:00, 23:00, 24:00）
 - 🌿 支持指定源分支和目标分支
 - 🔐 支持设置 GitHub 仓库的可见性（公开/私有）
-- 🚫 自动排除 `.git` 和 `.github` 目录
-- 🔑 安全的凭证管理
 
 ## 使用方法
 
+首先将本项目fork到自己的仓库中，然后按照以下步骤设置即可。
+
 ### 1. 配置文件设置
 
 在项目根目录创建 `sync-config.yml` 文件：
@@ -51,7 +50,7 @@
 
 在 GitHub 仓库的 Settings -> Secrets and variables -> Actions 中添加以下 secrets：
 
-- `GH_TOKEN`: GitHub Personal Access Token，需要有创建和管理仓库的权限
+- `GH_TOKEN`: GitHub Personal Access Token，需要有创建和管理仓库的权限(获取token路径：Settings -> Developer Settings -> Personal access tokens)
 - `GITEE_USERNAME`: Gitee 用户名
 - `GITEE_PASSWORD`: Gitee 密码或访问令牌
 
@@ -63,8 +62,6 @@
 - 23:00 - 第一次晚间同步
 - 24:00 - 最后一次同步
 
-也可以通过手动触发立即同步。
-
 ### 4. 手动触发同步
 
 1. 进入仓库的 Actions 页面
@@ -99,67 +96,3 @@
 ## 许可证
 
 [MIT License](LICENSE)
-
-## 项目结构
-
-### 核心文件说明
-
-1. **.github/workflows/gitee-sync.yml**
-   - GitHub Actions 的工作流配置文件
-   - 定义了自动同步的触发条件和执行步骤
-   - 包含了同步逻辑的具体实现
-   - 主要功能：
-     - 读取配置文件
-     - 创建/更新 GitHub 仓库
-     - 克隆 Gitee 仓库
-     - 同步代码到 GitHub
-     - 处理多仓库并行同步
-
-2. **sync-config.yml**
-   - 用户配置文件，需要根据 example 文件自行创建
-   - 定义需要同步的仓库信息
-   - 包含：
-     - Gitee 源仓库信息
-     - GitHub 目标仓库设置
-     - 分支配置
-     - 可见性设置
-
-3. **sync-config.yml.example**
-   - 配置文件的示例和模板
-   - 包含了不同场景的配置示例
-   - 提供了配置参考
-
-### 实现流程
-
-1. **配置解析**
-   - 读取 `sync-config.yml` 获取同步任务列表
-   - 使用 `yq` 工具解析 YAML 配置
-
-2. **任务分发**
-   - 使用 GitHub Actions 的 matrix 策略
-   - 并行处理多个仓库的同步任务
-
-3. **仓库处理**
-   - 检查 GitHub 仓库是否存在
-   - 自动创建不存在的仓库
-   - 更新仓库可见性设置
-
-4. **代码同步**
-   - 克隆指定分支的 Gitee 仓库
-   - 排除 `.git` 和 `.github` 目录
-   - 推送代码到 GitHub 指定分支
-
-5. **错误处理**
-   - 单个仓库同步失败不影响其他仓库
-   - 详细的错误日志输出
-   - 失败重试机制
-
-### 自动化运行
-
-- 按照预设时间自动运行（东八区）：
-  - 14:00
-  - 22:00
-  - 23:00
-  - 24:00
-- 支持手动触发运行
-- 使用 GitHub Actions 的调度系统