docs: 重构 README 结构并更新安装步骤
添加系统要求章节前置,优化新手使用说明的步骤编号和格式,补充常用命令示例,简化命令说明部分,并更新 uv.lock 使用清华 PyPI 镜像
This commit is contained in:
51
README.md
51
README.md
@@ -9,6 +9,12 @@
|
||||
- 支持自定义输出宽度和目录
|
||||
- 内置图片优化功能,使用图片优化引擎进行无损压缩
|
||||
|
||||
## 系统要求
|
||||
|
||||
- Windows 系统(使用 win32com 调用 PowerPoint)
|
||||
- Python >= 3.13
|
||||
- Microsoft PowerPoint
|
||||
|
||||
## 新手使用说明
|
||||
|
||||
如果你是第一次使用命令行工具,请按以下步骤操作。
|
||||
@@ -42,8 +48,8 @@ cd pptopic
|
||||
uv --version
|
||||
```
|
||||
|
||||
> 如果你已安装 [scoop](https://scoop.sh/),也可以直接 `scoop install uv`。
|
||||
> 如果想安装特定版本的 uv,可以在运行脚本前设置环境变量:`$env:UV_INSTALLER_VERSION = "0.11.20"`
|
||||
> - 如果你已安装 [scoop](https://scoop.sh/),也可以直接 `scoop install uv`。
|
||||
> - 如果想安装特定版本的 uv,可以在运行脚本前设置环境变量:`$env:UV_INSTALLER_VERSION = "0.11.20"`
|
||||
|
||||
### 第二步:安装 Python
|
||||
|
||||
@@ -79,10 +85,17 @@ uv pip install -e .
|
||||
pngquant --version
|
||||
```
|
||||
|
||||
> 自定义安装目录:`.\install-pngquant.ps1 -InstallDir "D:\Tools\pngquant"`
|
||||
> 强制重新安装:`.\install-pngquant.ps1 -Force`
|
||||
> - 自定义安装目录:`.\install-pngquant.ps1 -InstallDir "D:\Tools\pngquant"`
|
||||
> - 强制重新安装:`.\install-pngquant.ps1 -Force`
|
||||
|
||||
### 第五步:开始使用
|
||||
### 第五步:安装pptopic
|
||||
|
||||
```powershell
|
||||
uv sync
|
||||
uv pip install -e .
|
||||
```
|
||||
|
||||
### 第六步:开始使用
|
||||
|
||||
```powershell
|
||||
# 导出 PPTX 为长图
|
||||
@@ -90,6 +103,10 @@ pptopic export presentation.pptx
|
||||
|
||||
# 优化图片
|
||||
pptopic optimize image.png
|
||||
|
||||
# 工作中常用命令:导出 PPTX 为长图并优化图片
|
||||
# 其中,29999是微信接受的最大高度
|
||||
pptopic export presentation.pptx --optimize --max-height 29999 -o result.png
|
||||
```
|
||||
|
||||
至此安装完成。如果任何步骤遇到问题,请参考下方详细说明。
|
||||
@@ -115,6 +132,7 @@ scoop install uv
|
||||
### 安装 pptopic
|
||||
|
||||
```bash
|
||||
git clone https://git.lyz.one/SidneyZhang/pptopic.git
|
||||
cd pptopic
|
||||
uv sync
|
||||
uv pip install -e .
|
||||
@@ -128,14 +146,8 @@ uv pip install -e .
|
||||
# 基本用法
|
||||
pptopic export presentation.pptx
|
||||
|
||||
# 指定输出文件名
|
||||
pptopic export presentation.pptx --output result.png
|
||||
|
||||
# 优化导出的图片
|
||||
pptopic export presentation.pptx --optimize -o result.png
|
||||
|
||||
# 自定义宽度和最大高度
|
||||
pptopic export presentation.pptx --width 1080 --optimize --max-height 20000
|
||||
# 详细说明
|
||||
pptopic export --help
|
||||
```
|
||||
|
||||
### 单独优化图片
|
||||
@@ -144,19 +156,10 @@ pptopic export presentation.pptx --width 1080 --optimize --max-height 20000
|
||||
# 优化图片
|
||||
pptopic optimize image.png
|
||||
|
||||
# 指定输出文件
|
||||
pptopic optimize image.png --output optimized.png
|
||||
|
||||
# 自定义优化参数
|
||||
pptopic optimize image.png --max-height 20000 --engine pngquant
|
||||
# 详细说明
|
||||
pptopic optimize --help
|
||||
```
|
||||
|
||||
## 系统要求
|
||||
|
||||
- Windows 系统(使用 win32com 调用 PowerPoint)
|
||||
- Python >= 3.13
|
||||
- Microsoft PowerPoint
|
||||
|
||||
## 图片优化
|
||||
|
||||
为了获得最佳的图片压缩效果,推荐使用 [pngquant](https://pngquant.org/) 进行图片压缩。
|
||||
|
||||
Reference in New Issue
Block a user