From 926cb007a5264af8296b532d8b03c52e9e62634e Mon Sep 17 00:00:00 2001
From: moltbot <moltbot@foshanhuiya.com>
Date: Thu, 29 Jan 2026 01:32:44 +0000
Subject: [PATCH] Update README with complete project documentation

---
 README.md | 91 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 62 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 233c026..9040d41 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,69 @@
-# 网页版井字过三关游戏
+# 井字过三关游戏 - 完整项目文档
 
-## 项目介绍
-这是一个基于Web的井字过三关游戏（Tic-Tac-Toe），玩家可以在浏览器中享受经典的井字棋游戏。该游戏支持双人对战模式，具有直观的用户界面和流畅的游戏体验。
+## 项目概述
+这是一个基于Web的井字过三关游戏（Tic-Tac-Toe），具有直观的用户界面和流畅的游戏体验。项目实现了完整的CI/CD自动化流程。
 
-## 游戏玩法
-1. 游戏在一个3x3的网格上进行
-2. 两名玩家轮流放置自己的标记（X或O）
-3. 首先在横、竖或对角线上连成一线的玩家获胜
-4. 若9个格子填满仍未分出胜负，则为平局
+## 功能特性
+- 直观的3x3游戏棋盘
+- 实时玩家切换（X/O）
+- 胜利条件自动检测
+- 分数统计与持久化存储
+- 响应式设计适配不同设备
+- 胜利路径高亮动画
+- 新游戏和重置分数功能
 
 ## 技术架构
-- 前端：HTML5, CSS3, JavaScript (ES6+)
-- 无需后端：纯前端实现
-- 响应式设计：支持桌面和移动设备
-- 本地存储：保存游戏统计数据
+- **前端**: HTML5, CSS3, JavaScript (ES6+)
+- **无后端**: 纯前端实现
+- **响应式设计**: 支持桌面和移动设备
+- **本地存储**: 使用LocalStorage保存游戏统计数据
 
-## 项目特性
-- 直观的用户界面
-- 实时游戏状态显示
-- 游戏统计跟踪
-- 响应式设计
-- 无刷新页面交互
+## CI/CD 流水线
 
-## 安装与运行
-1. 克隆项目
-2. 直接在浏览器中打开index.html
-3. 开始游戏
+### 自动化流程
+1. **触发**: 每次推送到main分支时自动触发
+2. **构建与测试**: 验证代码完整性和安全性
+3. **开发部署**: 自动部署到开发环境
+4. **生产部署**: 经验证后部署到生产环境
+5. **清理**: 清理临时文件
 
-## 项目计划
-1. 设计游戏界面
-2. 实现核心游戏逻辑
-3. 添加游戏统计功能
-4. 实现响应式设计
-5. 添加音效和动画效果
-6. 测试和优化
\ No newline at end of file
+### 部署路径
+- **开发环境**: `http://<server-ip>/tic-tac-toe-dev/`
+- **生产环境**: `http://<server-ip>/tic-tac-toe/`
+
+### 配置文件
+- `.gitea/workflows/cicd.yml` - CI/CD工作流配置
+- `CICD_SETUP_GUIDE.md` - CI/CD配置指南
+
+## 文件结构
+```
+tic-tac-toe-game/
+├── index.html          # 主页面
+├── styles.css          # 样式文件
+├── script.js           # 游戏逻辑
+├── README.md           # 项目介绍
+├── PROJECT_PLAN.md     # 项目计划
+├── DEPLOYMENT.md       # 部署文档
+├── DOCKER_DEPLOY.md    # Docker部署说明
+├── PROJECT_SUMMARY.md  # 项目总结
+├── CICD_SETUP_GUIDE.md # CI/CD配置指南
+├── deploy.sh           # 部署脚本
+└── .gitea/workflows/
+    └── cicd.yml        # CI/CD工作流配置
+```
+
+## 部署要求
+要使CI/CD流水线正常工作，需要：
+1. 在目标服务器上配置Gitea Actions Runner
+2. 确保Runner有权限写入Web目录
+3. 设置适当的文件权限
+
+## 后续步骤
+1. 配置Gitea Actions Runner以执行部署任务
+2. 验证开发和生产环境部署
+3. 扩展游戏功能（如AI对手、在线对战等）
+
+## 维护
+- 游戏数据存储在用户浏览器中 (LocalStorage)
+- 更新只需推送代码到main分支即可自动部署
+- 查看 `CICD_SETUP_GUIDE.md` 了解故障排除方法
\ No newline at end of file