docs: 更新项目总览并同步子仓库指针

This commit is contained in:
2026-07-14 08:44:55 +00:00
parent d042f087db
commit c291a36772
3 changed files with 14 additions and 10 deletions
+12 -8
View File
@@ -4,12 +4,12 @@
## 一、项目整体是什么
本项目是一套面向 Windows 客户端软件的自动升级与版本控制系统,并补充实现了 SimCAE 崩溃报告后端接口。
本项目是一套面向 Windows/Linux 客户端软件的自动升级与版本控制系统,并补充实现了 SimCAE 崩溃报告后端接口。
整体分为两部分:
```text
update-client/ Windows 客户端升级运行时、SDK 打包脚本、接入说明文档
update-client/ Windows/Linux 客户端升级运行时、SDK 打包脚本、接入说明文档
update-server/ FastAPI 服务端、后台页面、Docker 部署和离线交付脚本
```
@@ -45,10 +45,10 @@ update-server/Docs/ 服务端说明文档
客户端核心程序:
```text
Launcher.exe 用户入口,检查更新并启动业务主程序
Updater.exe 下载、校验、安装、提交或回滚
Bootstrap.exe 辅助替换运行中的 EXE/DLL
MainApp.exe 当前仓库内的示例业务程序
Launcher.exe / Launcher 用户入口,检查更新并启动业务主程序
Updater.exe / Updater 下载、校验、安装、提交或回滚
Bootstrap.exe / Bootstrap 辅助替换运行中的 EXE/DLL 或 Linux 可执行文件
MainApp.exe / MainApp 当前仓库内的示例业务程序
```
已经实现的能力:
@@ -72,11 +72,13 @@ MainApp.exe 当前仓库内的示例业务程序
## 三、客户端 SDK 交付状态
已经提供 SDK 打包脚本:
已经提供 Windows 和 Linux SDK/客户端打包脚本:
```text
update-client/scripts/package-sdk.ps1
update-client/scripts/package-client.ps1
update-client/scripts/package-sdk.sh
update-client/scripts/package-client.sh
```
客户端文档现在统一放在:
@@ -87,7 +89,7 @@ update-client/Docs/客户端部署说明.md
update-client/Docs/第三方依赖说明.md
```
`package-sdk.ps1` 用于生成给业务开发者接入的 SDK 包。当前 SDK 包结构设计为:
`package-sdk.ps1` / `package-sdk.sh` 用于生成给业务开发者接入的 SDK 包。当前 SDK 包结构设计为:
```text
UpdateClientSDK/
@@ -102,6 +104,8 @@ UpdateClientSDK/
为了降低接入方理解成本,SDK 根目录只保留一个 Word 说明文档作为入口。
Linux 当前已完成 Qt 跨平台编译、Linux SDK 打包脚本、Linux 最终客户端打包脚本、Linux 配置模板和部署说明。真实 Linux 版 SimCAE 主程序还未由业务开发方交付,因此真实业务联调暂未完成。
Word 文档已经说明:
- 拿到 `UpdateClientSDK.zip` 后怎么操作。