Skip to content

Commit 5210642

Browse files
committed
docs: 更新 README 反映 Setup Wizard 功能
- 首次使用流程改为 GUI 优先(双击即用 + 配置向导) - 更新 v1.0 更新记录,新增 327 测试 - 常见问题补充 GUI 配置向导提示
1 parent 247337e commit 5210642

1 file changed

Lines changed: 20 additions & 24 deletions

File tree

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,37 @@ macOS 工具。Windows 用户推荐使用 QuantClass 官方客户端。
99

1010
---
1111

12-
## 三步开始用
12+
## 开始用
1313

14-
### 1. 装依赖
14+
### 方式一:图形界面(推荐)
1515

16-
```bash
17-
python3 -m pip install -r requirements.txt
18-
```
16+
双击 `QuantClass Sync.command`,首次运行会自动安装依赖并弹出配置向导。
1917

20-
如果你的数据里有 `.7z``.rar` 压缩包,还需要装一个额外依赖:
18+
填三样东西:数据目录(先从官网下载数据)、API Key、HID,点"开始使用"就行了。
2119

22-
```bash
23-
python3 -m pip install -r requirements-archive.txt
24-
```
20+
以后每次双击直接打开总览页,点"同步"更新数据。
2521

26-
### 2. 配置
22+
### 方式二:命令行
2723

2824
```bash
25+
# 1. 装依赖
26+
python3 -m pip install -r requirements.txt
27+
28+
# 2. 配置(填数据目录、API Key、HID)
2929
python3 quantclass_sync.py setup
30-
```
3130

32-
跟着提示填三样东西就行:数据存哪(`data_root`)、`API Key``HID`
31+
# 3. 更新数据
32+
python3 quantclass_sync.py
33+
```
3334

34-
> 小提示:第一次直接跑 `python3 quantclass_sync.py` 也会自动引导你配置
35+
搞定。后面每天只要重复第 3 步就行
3536

36-
### 3. 更新数据
37+
如果你的数据里有 `.7z``.rar` 压缩包,还需要装一个额外依赖:
3738

3839
```bash
39-
# 先试跑一次,看看会做什么(不会真的写数据)
40-
python3 quantclass_sync.py --dry-run
41-
42-
# 没问题就正式跑
43-
python3 quantclass_sync.py
40+
python3 -m pip install -r requirements-archive.txt
4441
```
4542

46-
搞定。后面每天只要重复第 3 步就行。
47-
4843
---
4944

5045
## 命令说明
@@ -125,7 +120,7 @@ python3 quantclass_sync.py gui
125120

126121
打开图形界面窗口,包含总览、同步、历史三个页面。关闭窗口后命令退出。
127122

128-
macOS 用户也可以直接双击 `QuantClass Sync.command` 启动 GUI,不需要打开终端。首次运行会提示输入 conda 环境名
123+
macOS 用户也可以直接双击 `QuantClass Sync.command` 启动 GUI,不需要打开终端。首次运行会自动安装依赖并弹出配置向导,全程不需要输入命令
129124

130125
### 币圈合成(自动的,不用管)
131126

@@ -198,7 +193,7 @@ ls -t <data_root>/.quantclass_sync/log/run_report_* | head -1 | xargs cat
198193

199194
**报"未找到用户配置文件"怎么办?**
200195

201-
先跑一次 `python3 quantclass_sync.py setup`
196+
用 GUI 的话,直接双击 `.command` 启动,会自动弹出配置向导。用命令行的话,跑一次 `python3 quantclass_sync.py setup`
202197

203198
**跑了但是没更新任何数据?**
204199

@@ -234,10 +229,11 @@ ls -t <data_root>/.quantclass_sync/log/run_report_* | head -1 | xargs cat
234229
<summary>v1.0</summary>
235230

236231
- 新增图形界面(GUI):总览、同步、历史三个页面
232+
- 新增首次启动向导:双击即用,自动安装依赖、引导配置,全程不需要命令行
237233
- 新增并发下载:`--workers` 参数支持 1-8 线程
238234
- 新增 `status` 命令:一屏查看全局同步状态
239235
- 新增 `.command` 双击启动 GUI(macOS)
240-
- 测试用例从 199 增加到 315
236+
- 测试用例从 199 增加到 327
241237

242238
</details>
243239

0 commit comments

Comments
 (0)