docs: 更新 README 安装说明并添加 PowerShell 基础知识介绍

This commit is contained in:
2026-06-12 11:54:33 +08:00
parent d8ee3b2a74
commit c0e8b59ba7
2 changed files with 40 additions and 15 deletions

3
.gitignore vendored
View File

@@ -8,4 +8,5 @@ wheels/
# Virtual environments
.venv
.vscode
.vscode
pptopic*.zip

View File

@@ -1,4 +1,4 @@
# pptopic
# pptopic 说明
将 PowerPoint 演示文稿导出为长图的工具。
@@ -23,6 +23,18 @@
- **PowerPoint**:需要安装 Microsoft PowerPointOffice 2016 或更新版本)
- **网络连接**:安装过程中需要下载工具
- **理解命令行工具**:你需要理解命令行的基本操作,包括文件路径、参数传递等。
### PowerShell的基本知识
PowerShell在Windows中是自带的所以一般情况下无需额外安装。如果你不知道如何打开可以在开始菜单搜索 "PowerShell",通常就能看见,点击后即可打开。
在PowerShell中跳转目录只需要输入 `cd` 加上目录路径即可。目录路径可以从资源管理器中在地址栏中复制。如果你的目录路径中包含空格,需要在路径中添加引号。
```powershell
# 这是一个例子
cd "C:\Users\User SomeX\Desktop\OneFolder"
```
### 第一步:安装 uv
@@ -31,7 +43,14 @@
打开 PowerShell在开始菜单搜索 "PowerShell"),进入本项目的目录:
```powershell
cd pptopic
cd "<你的解压目录>\pptopic"
```
赋予PowerShell执行权限
```powershell
Set-ExecutionPolicy Bypass -Scope CurrentUser
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```
运行项目自带的安装脚本:
@@ -59,13 +78,7 @@ uv --version
uv python install 3.13
```
### 第三步:安装 pptopic
```powershell
uv pip install -e .
```
### 第四步(可选):安装 pngquant 图片优化工具
### 第三步(可选):安装 pngquant 图片优化工具
虽然是可选安装但我超级建议你安装因为ppt导出后图片通常较大不进行图片无损压缩会导致文件大小过大。
@@ -88,10 +101,9 @@ pngquant --version
> - 自定义安装目录:`.\install-pngquant.ps1 -InstallDir "D:\Tools\pngquant"`
> - 强制重新安装:`.\install-pngquant.ps1 -Force`
### 第安装pptopic
### 第安装pptopic
```powershell
uv sync
uv tool install -e .
```
@@ -111,7 +123,7 @@ pptopic export presentation.pptx --optimize --max-height 29999 -o result.png
至此安装完成。如果任何步骤遇到问题,请参考下方详细说明。
## 安装
## 一般安装说明
### 安装 uv
@@ -129,12 +141,24 @@ pptopic export presentation.pptx --optimize --max-height 29999 -o result.png
scoop install uv
```
或者使用官方提供的安装脚本:
```bash
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
请注意,上述脚本都需要相关的脚本运行权限,否则无法正常运行,一般如下操作即可获取相关权限:
```powershell
Set-ExecutionPolicy Bypass -Scope CurrentUser
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```
### 安装 pptopic
```bash
git clone https://git.lyz.one/SidneyZhang/pptopic.git
cd pptopic
uv sync
uv tool install -e .
```
@@ -184,7 +208,7 @@ pptopic optimize --help
# 强制重新安装
.\install-pngquant.ps1 -Force
# 不修改 PATH
# 不修改 PATH ,将无法全局使用这个工具
.\install-pngquant.ps1 -NoModifyPath
```