Skip to content

Commit d601b15

Browse files
docs: upgrade bilingual README and add screenshot section placeholders
1 parent e4e2062 commit d601b15

File tree

3 files changed

+170
-26
lines changed

3 files changed

+170
-26
lines changed

README.md

Lines changed: 131 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,155 @@
1-
# QueScript (v1.0)
1+
# QueScript
22

3-
QueScript is a local survey simulation toolkit with a GUI, automatic questionnaire generation, batch response simulation, and data quality analysis (reliability/validity/discrimination/EFA).
3+
<div align="center">
44

5-
## Features
5+
本地优先、可审计的问卷模拟与测量分析工具。
66

7-
- Convert plain-text questionnaire content into HTML survey pages
8-
- Run batch smart simulation with configurable sample size and response bias
9-
- Enforce skip logic paths and output audit artifacts (`config.json`, `path_log.csv`)
10-
- Generate analysis report including:
11-
- Cronbach's alpha
12-
- KMO + Bartlett test
13-
- Item-level discrimination (CR)
14-
- CITC / alpha-if-deleted diagnostics
15-
- EFA factor outputs
16-
- Offline packaging support for Windows (PyInstaller + Inno Setup)
7+
[![Stars](https://img.shields.io/github/stars/SakuraMathcraft/QueScript?style=for-the-badge)](https://github.com/SakuraMathcraft/QueScript/stargazers)
8+
[![Forks](https://img.shields.io/github/forks/SakuraMathcraft/QueScript?style=for-the-badge)](https://github.com/SakuraMathcraft/QueScript/network/members)
9+
[![Issues](https://img.shields.io/github/issues/SakuraMathcraft/QueScript?style=for-the-badge)](https://github.com/SakuraMathcraft/QueScript/issues)
10+
[![Last Commit](https://img.shields.io/github/last-commit/SakuraMathcraft/QueScript?style=for-the-badge)](https://github.com/SakuraMathcraft/QueScript/commits/main)
11+
[![License](https://img.shields.io/github/license/SakuraMathcraft/QueScript?style=for-the-badge)](LICENSE)
1712

18-
## Quick Start
13+
</div>
14+
15+
---
16+
17+
## 项目概览
18+
19+
QueScript 面向“**全流程问卷仿真 + 测量质量评估**”场景,强调离线运行与可复现:
20+
21+
- 文本问卷快速生成 HTML 页面
22+
- 智能批量模拟(跳题、分支、偏好倾向、潜变量)
23+
- 题级与结构级分析(Alpha、KMO/Bartlett、CR、CITC、EFA、CFA/Omega)
24+
- 审计与复现产物输出(`config.json``path_log.csv``analysis_meta.json`
25+
26+
## Star 趋势
27+
28+
<a href="https://star-history.com/#SakuraMathcraft/QueScript&Date" target="_blank">
29+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SakuraMathcraft/QueScript&type=Date" />
30+
</a>
31+
32+
## 功能矩阵
33+
34+
| 模块 | 能力说明 |
35+
|---|---|
36+
| 问卷生成 | 将问卷文本解析为 `index.html` |
37+
| 智能模拟 | 批量填写、分支跳题、作答倾向与潜变量控制 |
38+
| 统计分析 | 信效度、区分度、EFA/CFA、分支感知分析 |
39+
| 审计复现 | `run_id + seed + 配置快照 + 路径日志 + 分析快照` |
40+
| 打包发布 | Windows 离线打包(PyInstaller + 安装脚本) |
41+
42+
## 界面截图
43+
44+
> 下图为仓库内置占位图;可将真实截图替换为同名文件以展示实际界面效果。
45+
46+
### GUI 主界面
47+
48+
![GUI Main](docs/images/gui-main.svg)
49+
50+
### 报告示例
51+
52+
![Report Sample](docs/images/report-sample.svg)
53+
54+
## 快速开始
1955

2056
```powershell
21-
cd E:\QueScript
57+
git clone https://github.com/SakuraMathcraft/QueScript.git
58+
cd QueScript
59+
python -m venv .venv
2260
.\.venv\Scripts\activate
61+
pip install -r requirements.txt
2362
python mock_survey\gui_launcher.py
2463
```
2564

26-
## Dependencies
65+
Windows 双击方式:
66+
67+
```powershell
68+
cd mock_survey
69+
run_gui.bat
70+
```
71+
72+
## 离线打包(Windows)
73+
74+
```powershell
75+
powershell -ExecutionPolicy Bypass -File .\packaging\build_package.ps1 -LocalChromeZip ".\chrome-win64.zip"
76+
```
77+
78+
## 项目结构
79+
80+
- `mock_survey/`: GUI、模拟核心、统计分析、问卷生成
81+
- `packaging/`: 打包脚本、安装器配置、PyInstaller 规范
82+
- `docs/images/`: README 截图资源
83+
- `requirements.txt`: 运行依赖
84+
85+
## 复现产物说明
86+
87+
每次模拟后,问卷目录中会生成:
88+
89+
- `survey_data_collected.csv`: 采集结果
90+
- `config.json`: 模拟参数快照
91+
- `path_log.csv`: 样本访问轨迹与跳转原因
92+
- `analysis_meta.json`: 分析口径、门槛、纳入题项与签名
93+
94+
## 使用建议
95+
96+
- 建议样本量 `n >= 100`,结构分析更稳定
97+
- 分支较强的问卷,优先查看分层分析结论
98+
- 每个潜变量维度建议至少 3 道可比题项
99+
- 覆盖率口径适合业务分析,严格公共题口径适合保守对比
100+
101+
## Roadmap
102+
103+
- 多分支结构诊断进一步增强
104+
- 报告导出模板与可视化增强
105+
- 跨平台打包能力完善
106+
107+
## Contributing
27108

28-
Install dependencies:
109+
欢迎 Issue 和 PR:
110+
111+
1. 提供可复现问题描述
112+
2. 附上输入样本与预期行为
113+
3. 需要时附带 `config.json``path_log.csv``analysis_meta.json`
114+
115+
## English (Collapsible)
116+
117+
<details>
118+
<summary>Click to expand English README</summary>
119+
120+
### Overview
121+
122+
QueScript is a local-first toolkit for **auditable survey simulation and measurement analysis**.
123+
124+
- Generate HTML surveys from plain questionnaire text
125+
- Run branch-aware batch simulation with skip logic and response tendencies
126+
- Evaluate data quality with Alpha, KMO/Bartlett, CR, CITC, EFA, CFA/Omega
127+
- Preserve reproducibility artifacts (`config.json`, `path_log.csv`, `analysis_meta.json`)
128+
129+
### Quick Start
29130

30131
```powershell
132+
git clone https://github.com/SakuraMathcraft/QueScript.git
133+
cd QueScript
134+
python -m venv .venv
135+
.\.venv\Scripts\activate
31136
pip install -r requirements.txt
137+
python mock_survey\gui_launcher.py
32138
```
33139

34-
## Packaging (Windows, offline)
140+
### Offline Packaging (Windows)
35141

36142
```powershell
37-
cd E:\QueScript
38-
powershell -ExecutionPolicy Bypass -File .\packaging\build_package.ps1 -LocalChromeZip "E:\QueScript\chrome-win64.zip"
143+
powershell -ExecutionPolicy Bypass -File .\packaging\build_package.ps1 -LocalChromeZip ".\chrome-win64.zip"
39144
```
40145

41-
## Project Structure
146+
### Screenshots
42147

43-
- `mock_survey/`: simulation core, GUI launcher, survey generator, analysis
44-
- `packaging/`: build scripts and installer configuration
45-
- `requirements.txt`: Python dependencies
148+
- GUI Main: `docs/images/gui-main.svg`
149+
- Report Sample: `docs/images/report-sample.svg`
46150

47-
## License
151+
</details>
48152

49-
MIT License
153+
## License
50154

155+
MIT License. See `LICENSE`.

docs/images/gui-main.svg

Lines changed: 18 additions & 0 deletions
Loading

docs/images/report-sample.svg

Lines changed: 21 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)