📝 Refactoring documentation

This commit is contained in:
Tw93
2025-09-06 23:27:27 +08:00
parent 50d85fad52
commit e33f7f43e7
9 changed files with 358 additions and 252 deletions

View File

@@ -1,5 +1,9 @@
# CLI 使用指南
<h4 align="right"><strong><a href="cli-usage.md">English</a></strong> | 简体中文</h4>
完整的命令行参数说明和基础用法指南。
## 安装
请确保您的 Node.js 版本为 22 或更高版本(例如 22.11.0。_注意较旧的版本 ≥18.0.0 也可能可以工作。_
@@ -28,42 +32,11 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
```
<details>
<summary><strong>Windows/Linux 注意事项</strong></summary>
**前置条件:**
- **非常重要**:请参阅 Tauri 的 [依赖项指南](https://tauri.app/start/prerequisites/)。
- 对于 Windows 用户,请确保至少安装了 `Win10 SDK(10.0.19041.0)``Visual Studio Build Tools 2022版本 17.2 或更高)`,此外还需要安装以下组件:
1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
3. Microsoft Visual C++ 2012 Redistributable (x86)(可选)
4. Microsoft Visual C++ 2013 Redistributable (x86)(可选)
5. Microsoft Visual C++ 2008 Redistributable (x86)(可选)
**Windows ARMARM64支持**:在 Visual Studio Installer 中的"单个组件"下安装"MSVC v143 - VS 2022 C++ ARM64 构建工具"。系统会自动检测 ARM64 架构并构建原生 ARM64 二进制文件。
- 对于 Ubuntu 用户,在开始之前,建议运行以下命令以安装所需的依赖项:
```bash
sudo apt install libdbus-1-dev \
libsoup-3.0-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra \
libglib2.0-dev \
pkg-config
```
</details>
- Node.js ≥18.0.0
- Rust ≥1.78.0(如缺失将自动安装)
- **Windows/Linux**:详细系统依赖请参考 [高级用法指南](advanced-usage_CN.md#前置条件)
## 快速开始
@@ -349,7 +322,7 @@ pake https://github.com --name GitHub --keep-binary
#### [title]
设置窗口标题栏文本。如果未指定,窗口标题将为空
设置窗口标题栏文本macOS 未指定时不显示标题Windows/Linux 回退使用应用名称
```shell
--title <string>
@@ -416,26 +389,6 @@ pake ./my-app/index.html --name "my-app" --use-local-file
完成上述步骤后,您的应用程序应该已经成功打包。请注意,根据您的系统配置和网络状况,打包过程可能需要一些时间。请耐心等待,一旦打包完成,您就可以在指定的目录中找到应用程序安装包。
## 开发调试
开发时可以修改 `bin/defaults.ts` 中 `DEFAULT_DEV_PAKE_OPTIONS` 配置,配置项和 `pake-cli` 配置说明保持一致
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
...DEFAULT_PAKE_OPTIONS,
url: "https://weekly.tw93.fun/",
name: "Weekly",
};
```
之后运行
```bash
pnpm run cli:dev
```
脚本会读取上述配置并使用 `watch` 模式打包指定的 `app`,对 `pake-cli` 代码和 `pake` 的修改都会实时热更新。
## Docker 使用
```shell