From 95aaf9bed0a56c65a4f60f85307cfba51d7c72e9 Mon Sep 17 00:00:00 2001
From: "qichi.liang" <qichi.liang@westwell-lab.com>
Date: Tue, 3 Mar 2026 02:14:47 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=20README=20=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4f1d7af
--- /dev/null
+++ b/README.md
@@ -0,0 +1,77 @@
+# Gloria - 福州港日报管理系统
+
+从飞书获取排班信息，从 Metabase 获取船舶作业数据，生成标准化日报。
+
+## 功能
+
+- **日报生成**: 自动生成每日作业报告
+- **班次交接报告**: 分别统计白班/夜班作业情况
+- **GUI 界面**: 基于 Tkinter 的图形界面
+- **CLI 支持**: 命令行方式运行
+
+## 项目结构
+
+```
+Gloria/
+├── daily_report_gui.py    # GUI 入口
+├── report_generator.py    # 日报生成核心
+├── shift_report.py        # 班次交接报告
+├── feishu/                # 飞书 API 集成
+├── metabase/              # Metabase 数据查询
+└── template/              # 报告模板
+```
+
+## 快速开始
+
+### 环境要求
+
+- Python 3.10+
+- 依赖: `requests`, `python-dotenv`
+
+### 安装
+
+```bash
+pip install requests python-dotenv
+```
+
+### 配置
+
+创建 `.env` 文件：
+
+```
+MATEBASE_USERNAME=xxx
+MATEBASE_PASSWORD=xxx
+FEISHU_APP_ID=xxx
+FEISHU_APP_SECRET=xxx
+FEISHU_SPREADSHEET_TOKEN=xxx
+```
+
+### 运行
+
+```bash
+# GUI 模式
+python daily_report_gui.py
+
+# 日报 (CLI)
+python report_generator.py --date 2026-03-01
+
+# 班次交接报告
+python shift_report.py --date 2026-03-01 --shift day
+python shift_report.py --date 2026-03-01 --shift night
+```
+
+## 班次时间
+
+| 类型 | 时间范围 |
+|------|----------|
+| 白班 | 08:00 - 20:00 |
+| 夜班 | 20:00 - 次日 08:00 |
+
+## 注意事项
+
+- 程序需在 **8:00 后运行**，确保最后一条船指令结束时间超过 8 点
+- 飞书 Token 自动刷新，提前 30 分钟续期
+
+## License
+
+MIT
\ No newline at end of file