docs: 重构 README 新手使用说明,添加一键安装脚本文档

This commit is contained in:
2026-06-22 15:42:44 +08:00
parent cba7f9fb55
commit 04ef9b65a5
4 changed files with 529 additions and 70 deletions

133
README.md
View File

@@ -17,26 +17,94 @@
## 新手使用说明
如果你是第一次使用命令行工具,请按以下步骤操作。
如果你是第一次使用命令行工具,请按以下步骤操作。我们提供了一键安装脚本,尽量让你少输入命令。
### 准备工作
### 安装前准备
- **PowerPoint**:需要安装 Microsoft PowerPointOffice 2016 或更新版本)
- **网络连接**:安装过程中需要下载工具
- **理解命令行工具**:你需要理解命令行的基本操作,包括文件路径、参数传递等。
- **解压项目**:把下载的 `pptopic.zip` 解压到任意位置,例如桌面
### PowerShell的基本知识
### 一键安装(推荐)
PowerShell在Windows中是自带的所以一般情况下无需额外安装。如果你不知道如何打开可以在开始菜单搜索 "PowerShell",通常就能看见,点击后即可打开。
项目根目录下有一个 `setup.bat`,它会自动完成:
在PowerShell中跳转目录只需要输入 `cd` 加上目录路径即可。目录路径可以从资源管理器中在地址栏中复制。如果你的目录路径中包含空格,需要在路径中添加引号。
1. 安装 `uv`Python 包管理器)
2. 安装 Python 3.13
3. 安装 `pngquant`(图片压缩工具,强烈推荐)
4. 安装 `pptopic`
5. 验证安装结果
#### 方法 A双击运行最简单
1. 打开解压后的 `pptopic` 文件夹
2. 找到 `setup.bat` 文件
3. **双击** `setup.bat`
4. 等待安装完成,窗口会显示版本信息
> 如果 Windows 提示“Windows 已保护你的电脑”,请点击“更多信息” → “仍要运行”。
#### 方法 B右键在 PowerShell 中运行
如果双击运行被系统拦截,可以按以下步骤:
1. 打开解压后的 `pptopic` 文件夹
2. 在文件夹**空白处**按住 `Shift` 键,同时点击**鼠标右键**
3. 选择“在此处打开 PowerShell 窗口”Windows 11 可能显示为“在终端中打开”)
4. 在弹出的蓝色窗口中输入以下命令,然后按回车:
```powershell
# 这是一个例子
cd "C:\Users\User SomeX\Desktop\OneFolder"
.\setup.bat
```
### 第一步:安装 uv
等待安装完成即可。
#### 安装完成后
如果看到类似下面的输出,说明安装成功:
```
--- uv 版本 ---
uv 0.11.20
--- pngquant 版本 ---
2.17.0
--- pptopic 版本 ---
pptopic 0.3.2
```
然后你可以直接在当前窗口使用 pptopic
```powershell
# 导出 PPTX 为长图
pptopic export presentation.pptx
# 工作中常用命令:导出 PPTX 为长图并优化图片
# 其中29999 是微信接受的最大高度
pptopic export presentation.pptx --optimize --max-height 29999 -o result.png
```
### 一键安装脚本的参数(可选)
如果你不想安装 pngquant可以使用以下方式运行
```powershell
# 在 PowerShell 中直接运行 setup.ps1跳过 pngquant
powershell -ExecutionPolicy Bypass -File .\setup.ps1 -SkipPngquant
```
其他可用参数:
- `-SkipPngquant`:跳过 pngquant 安装
- `-Force`:强制重新安装 uv 和 pngquant
- `-SkipPptopicInstall`:只安装环境,不安装 pptopic
### 手动安装(备用)
如果一键安装脚本在你的电脑上无法运行,可以按以下步骤手动安装。
#### 第一步:安装 uv
`uv` 是一个 Python 包管理器,用来安装 pptopic 及其依赖。
@@ -46,7 +114,7 @@ cd "C:\Users\User SomeX\Desktop\OneFolder"
cd "<你的解压目录>\pptopic"
```
赋予PowerShell执行权限
赋予 PowerShell 执行权限:
```powershell
Set-ExecutionPolicy Bypass -Scope CurrentUser
@@ -70,7 +138,7 @@ uv --version
> - 如果你已安装 [scoop](https://scoop.sh/),也可以直接 `scoop install uv`。
> - 如果想安装特定版本的 uv可以在运行脚本前设置环境变量`$env:UV_INSTALLER_VERSION = "0.11.20"`
### 第二步:安装 Python
#### 第二步:安装 Python
使用 uv 安装 Python 3.13 或更新版本:
@@ -78,9 +146,9 @@ uv --version
uv python install 3.13
```
### 第三步(可选):安装 pngquant 图片优化工具
#### 第三步(可选):安装 pngquant 图片优化工具
虽然是可选安装但我超级建议你安装因为ppt导出后图片通常较大不进行图片无损压缩会导致文件大小过大。
虽然是可选安装,但我超级建议你安装,因为 ppt 导出后,图片通常较大,不进行图片无损压缩,会导致文件大小过大。
如果你需要对导出的图片进行压缩优化,运行:
@@ -101,13 +169,13 @@ pngquant --version
> - 自定义安装目录:`.\install-pngquant.ps1 -InstallDir "D:\Tools\pngquant"`
> - 强制重新安装:`.\install-pngquant.ps1 -Force`
### 第四步安装pptopic
#### 第四步:安装 pptopic
```powershell
uv tool install -e .
```
### 第五步:开始使用
#### 第五步:开始使用
```powershell
# 导出 PPTX 为长图
@@ -117,11 +185,11 @@ pptopic export presentation.pptx
pptopic optimize image.png
# 工作中常用命令:导出 PPTX 为长图并优化图片
# 其中29999是微信接受的最大高度
# 其中29999 是微信接受的最大高度
pptopic export presentation.pptx --optimize --max-height 29999 -o result.png
```
至此安装完成。如果任何步骤遇到问题,请参考下方详细说明。
至此安装完成。
## 一般安装说明
@@ -222,6 +290,37 @@ scoop install pngquant
或从 [pngquant.org](https://pngquant.org/) 下载 Windows 版本手动配置。
## 常见问题
### 运行 `setup.bat` 时提示“无法加载文件,因为在此系统上禁止运行脚本”
这说明当前电脑通过组策略严格限制了脚本执行。`setup.bat` 已经尝试用 `-ExecutionPolicy Bypass` 绕过,但仍可能被拦截。
解决方法:使用 **方法 B**,在 PowerShell 窗口中手动运行:
```powershell
powershell -ExecutionPolicy Bypass -File .\setup.ps1
```
不需要以管理员身份运行,本安装脚本只修改当前用户的环境变量。
### 安装完成后关闭窗口,新窗口中找不到 `pptopic` 命令
请重新运行一次 `setup.bat`。如果问题依旧,请检查系统环境变量中的 PATH 是否包含以下目录:
- `%USERPROFILE%\.local\bin`uv 和 pptopic 的位置)
- `%APPDATA%\pngquant`pngquant 的位置)
### 不想安装 pngquant 怎么办?
可以运行:
```powershell
powershell -ExecutionPolicy Bypass -File .\setup.ps1 -SkipPngquant
```
但强烈建议安装,否则导出的长图文件会比较大。
## License
MIT License