Files
MDHelper/pack/README.md
T

55 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Windows 安装版构建
双击本目录的 `_installer.cmd`,或在任意工作目录调用它的完整路径。
成功、失败都会显示结果并保留窗口;失败返回非零退出码,并停止后续打包。
## 产物
- `pack/output/MDHelper-Setup-<版本号>-x64.exe`:发给用户的安装程序。
- 同名 `.exe.sha256`:SHA256 校验值。
- `dist/MDHelper/`:安装器使用的完整程序目录。内部 EXE 不能单独复制使用。
- `pack/logs/build-*.log`:构建日志。
安装器默认安装到当前用户的 `%LOCALAPPDATA%\Programs\MDHelper`,可修改目标目录。
提供开始菜单入口、可选桌面快捷方式,以及 Windows“已安装的应用”中的卸载入口。
更新安装沿用固定 AppId 和原安装目录。配置、书签等沿用旧版 QSettings,卸载不删除用户文档和阅读配置。
安装后不需要 Python、Pandoc 或联网;公式和图表资源均在本地。
安装 EXE 会在安装时解压。日常使用启动的是安装目录中的 MDHelper.exe,不会每次解压整套 Qt 和 Pandoc。
旧的 `dist/MDHelper.exe` 是历史单文件产物,脚本保留它但不再生成或更新它。
## 首次构建
1. 准备 64 位 Python 3.10 或以上。优先复用项目现有虚拟环境,包括 `mdhelper_env/mdhelper_env` 的嵌套布局。
2. 缺少或不符合 `requirements.txt` 的依赖时,脚本会安装锁定版本;需要网络。
3. 缺少 pytest 时自动安装,默认执行全部单元回归测试。
4. 优先使用已安装的 Inno Setup。未找到时下载官方 Inno Setup 6.7.3,校验 Windows 数字签名和发布者,再按当前用户安装到 `pack/.tools/InnoSetup6`。首次需要网络,之后可复用缓存。
5. 项目应保留 `vendor/pandoc/pandoc.exe` 及其许可证文件。Pandoc 随应用目录安装,只有导出 DOCX 时才运行。
脚本不会启动安装后的 MDHelper,也不会替你执行生成的安装程序。
构建工具的使用条件见 [Inno Setup 官网](https://jrsoftware.org/isinfo.php)。
## 自动化和自定义
```bat
pack\_installer.cmd -NoPause
pack\_installer.cmd -NoPause -SkipTests
```
`-SkipTests` 只用于明确需要跳过已验证测试的重复构建。默认仍会执行测试。
也可设置 `MDHELPER_NO_PAUSE=1` 取消结束暂停。
使用指定工具路径:
```bat
set "MDHELPER_PYTHON=C:\Path\To\python.exe"
set "MDHELPER_ISCC=C:\Path\To\ISCC.exe"
pack\_installer.cmd
```
如果指定的是系统 Python,脚本先在 `pack/.venv` 创建独立构建环境。
离线构建前,请先准备好依赖、Pandoc 和 Inno Setup;工具缺失时脚本会明确报错。
版本号读取 `mdhelper/__init__.py`,安装器定义在 `MDHelper.iss`,目录式打包定义在根目录 `MDHelper.spec`。
安装器暂未配置代码签名证书,生成的 MDHelper 安装 EXE 为未签名文件。