更新项目说明文档

README.md

@@ -1 +1,49 @@
-# README
+# A股智能量化工作台
+
+本项目是一个面向个人散户与量化爱好者的 **A 股「选股 + 监控 + 回测」量化工作台**，采用前后端分离架构，支持 Docker 一键部署。
+
+## 目录结构
+
+```
+stock/
+├── local/    # 本地完整版（满血功能）
+└── serve/    # 服务端轻量版（备份 + 基础查看）
+```
+
+### local/ — 本地完整版
+
+自托管的满血工作站，所有功能本地运行：
+
+- **选股**：20+ 内置策略，支持自定义信号与 AI 生成策略
+- **回测**：基于 vectorbt 的向量化回测，支持 T+1、手续费、止损等真实约束
+- **实时监控**：策略 / 个股信号 / 价格 / 异动四类规则，SSE 实时告警 + 飞书推送
+- **个股分析**：日 K 图表、9 类关键价位、AI 四维分析
+- **数据扩展**：TickFlow 多源数据 + 第三方 HTTP / CSV / Excel 接入
+
+详细说明与部署指南见 [`local/README.md`](./local/README.md)。
+
+### serve/ — 服务端轻量版
+
+`local/` 的云端伴侣，用于**数据备份**与**远程基础查看**：
+
+- 接收 `local/` 推送的选股结果、复盘报告、历史 K 线等基础数据
+- 支持多用户（admin / viewer）角色隔离
+- 不包含回测、实时监控、实时行情等需要本地运行的能力
+
+详细说明与部署指南见 [`serve/README.md`](./serve/README.md)。
+
+## 快速选择
+
+| 场景 | 使用目录 |
+| :--- | :--- |
+| 在自己的电脑 / 服务器上跑完整功能 | [`local/`](./local/README.md) |
+| 只需要远程备份和查看基础数据 | [`serve/`](./serve/README.md) |
+| 既要本地分析，又要远程查看 | 同时部署 `local/` + `serve/`，并通过 `SYNC_SERVE_URL` 同步 |
+
+## 数据安全提示
+
+两个目录下的 `data/` 文件夹均为运行时生成的用户数据，**不纳入 git 管理**。更新代码时 `git pull` 不会影响已有数据，但请勿使用 `git clean -fdx` 或 `git reset --hard`，以免误删数据。
+
+## 开源协议
+
+[MIT](./LICENSE)