Files
Pake/bin/README.md
2023-04-10 22:14:05 +08:00

158 lines
3.9 KiB
Markdown
Vendored
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## 安装
请确保 Node 版本>=16 如 16.8,不要使用 sudo 进行安装,假如 npm 报没有权限可以参考 [How to fix npm throwing error without sudo](https://stackoverflow.com/questions/16151018/how-to-fix-npm-throwing-error-without-sudo)。
```bash
npm install -g pake-cli
```
## Windows/Linux 注意点
- **十分重要** 查看 Tauri 提供的[依赖指南](https://tauri.app/v1/guides/getting-started/prerequisites)
- 对于 windows至少安装了`Win10 SDK(10.0.19041.0)``Visual Studio build tool 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)(可选)
- 此外 Ubuntu 在开始之前可以运行如下命令,安装前期所需依赖。
```bash
sudo apt install libdbus-1-dev \
libsoup2.4-dev \
libjavascriptcoregtk-4.0-dev \
libwebkit2gtk-4.0-dev \
build-essential \
curl \
wget \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra
```
## 用法
```bash
pake url [options]
```
打包完成后的应用程序默认为当前工作目录,首次打包由于需配置好环境,需要一些时间,请耐心等待即可。
> **Note**:
> 打包需要用 `Rust` 环境,如果没有 `Rust`,会提示确认安装。如遇安装失败或超时,可[自行安装](https://www.rust-lang.org/tools/install)。
### url
url 为你需要打包的网页链接 🔗 或者本地 html 文件,必须提供。
### [options]
提供了一些特定的选项,打包时可以传递对应参数达到定制化的效果。
#### [name]
应用名称,如输入时未指定,会提示你输入,尽量使用英语。
```shell
--name <value>
# 或者
-n <value>
```
#### [icon]
应用 icon支持本地/远程文件,默认为 Pake 自带图标,定制的可以去 [icon-icons](https://icon-icons.com) 或 [macOSicons](https://macosicons.com/#/) 搜索下载。
- MacOS 下必须为 `.icns`
- Windows 下必须为 `.ico`
- Linux 下必须为 `.png`
```shell
--icon <path>
# 或者
-i <path>
```
#### [height]
打包后的应用窗口高度,默认 `780px`。
```shell
--height <number>
# 或者
-h <number>
```
#### [width]
打包后的应用窗口宽度,默认 `1200px`。
```shell
--width <number>
# 或者
-w <number>
```
#### [transparent]
是否开启沉浸式头部,默认为 `false` 不开启,输入下面的命令则开启沉浸式,推荐 MacOS 用户开启。
```shell
--transparent
```
#### [resize]
是否可以拖动大小,默认为 `true` 可拖动,输入下面的命令则不能对窗口大小进行拉伸。
```shell
--no-resizable
```
#### [fullscreen]
打开应用后是否开启全屏,默认为 `false`,输入下面的命令则会自动全屏。
```shell
--fullscreen
```
#### [multi-arch]
打包结果同时支持英特尔和 m1 芯片,仅适用于 MacOS默认为 `false`。
##### 准备工作
- 注意:开启该选项后,需要用 rust 官网的 rustup 安装 rust不支持 brew 安装。
- 对于 intel 芯片用户,需要安装 arm64 跨平台包,使安装包支持 m1 芯片,使用下面命令安装。
```shell
rustup target add aarch64-apple-darwin
```
- 对于 M1 芯片用户,需要安装 x86 跨平台包,使安装包支持 interl 芯片,使用下面的命令安装。
```shell
rustup target add x86_64-apple-darwin
```
##### 使用方法
```shell
--multi-arch
# 或者
-m
```
#### [targets]
选择输出的包格式,支持 deb/appimage/all如果选择 all,则同时打包 deb 和 appimage该选项仅支持 Linux默认为`all`。
```shell
--targets xxx
```