From 0998cb393b23b6fab72ed702be58d591d951a5ae Mon Sep 17 00:00:00 2001
From: xuncha <1658671838@qq.com>
Date: Wed, 24 Dec 2025 23:13:32 +0800
Subject: [PATCH] Add detailed usage steps to README
---
readme.md | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/readme.md b/readme.md
index 6f50be9..f602a4c 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,6 @@
# 此项目fork自 [WeChatMsg](https://github.com/LC044/WeChatMsg),使用gemini新增了2025年度报告,目前暂无gui界面。
+
## 现已支持微信4.0,[点击查看详细设计文档](https://blog.lc044.love/post/13)
我的数据我做主
@@ -78,6 +79,37 @@
## 源码运行
+### 1. 环境准备
+1. 下载并安装 [Python 3.10+](https://www.python.org/downloads/),安装时请勾选 `Add Python to PATH`。
+2. 下载并安装 **微信 4.0.3.22** 版本。
+3. 下载并安装 [Node.js](https://nodejs.org/) (用于预览网页版报告)。
+
+### 2. 安装依赖
+在项目根目录下打开终端,运行以下命令安装 Python 依赖:
+```bash
+pip install -r requirements.txt
+```
+
+### 3. 生成年度报告数据
+1. 使用文本编辑器打开 `generate_report_data.py` 文件。
+2. 修改 `db_dir` 变量,将其改为您电脑上微信数据库的实际路径(通常位于 `WeChat Files\wxid_xxxx\db_storage`)。
+3. 运行脚本生成数据:
+```bash
+python generate_report_data.py
+```
+
+### 4. 启动报告预览
+1. 进入报告前端目录:
+```bash
+cd AnnualReport/report-2025/single
+```
+2. 安装前端依赖并启动服务:
+```bash
+npm install
+npm run dev
+```
+3. 脚本运行成功后会显示一个本地链接(如 `http://localhost:5173`),复制到浏览器打开即可查看您的2025年度报告。
+
## PC端使用过程中部分问题解决(可参考)
#### 🤔如果您在pc端使用的时候出现问题,可以先参考以下方面,如果仍未解决,可以在群里交流~