lostecho/Pake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 Documentation is clearer

Browse Source
This commit is contained in:
Tw93
2025-09-07 08:31:38 +08:00
parent 13f9c69476
commit c097f90006
5 changed files with 23 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -158,14 +158,14 @@ In addition, double-click the title bar to switch to full-screen mode. For Mac u
![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif)
```bash ```bash
# Install # Install Pake CLI
pnpm install -g pake-cli pnpm install -g pake-cli
# Basic usage (auto-fetch website icon) # Basic usage - automatically fetches website icon
pake https://weekly.tw93.fun --name Weekly pake https://github.com --name "GitHub"
# Common options: --name app name, --icon custom icon, --width/--height window size, --hide-title-bar macOS immersive # Advanced usage with custom options
pake https://weekly.tw93.fun --name Weekly --icon https://cdn.tw93.fun/pake/weekly.icns --hide-title-bar pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar
``` ```
First-time packaging requires environment setup and may be slower, subsequent builds are fast. For complete parameter documentation, see [CLI Usage Guide](docs/cli-usage.md). Don't want to use CLI? Try [GitHub Actions Online Building](docs/github-actions-usage.md). First-time packaging requires environment setup and may be slower, subsequent builds are fast. For complete parameter documentation, see [CLI Usage Guide](docs/cli-usage.md). Don't want to use CLI? Try [GitHub Actions Online Building](docs/github-actions-usage.md).

10
README_CN.md
View File

@@ -159,14 +159,14 @@
![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif)
```bash ```bash
# 安装 # 安装 Pake CLI
pnpm install -g pake-cli pnpm install -g pake-cli
# 基础使用（自动获取网站图标） # 基础用法 - 自动获取网站图标
pake https://weekly.tw93.fun --name Weekly pake https://github.com --name "GitHub"
# 常用参数：--name 应用名称，--icon 自定义图标，--width/--height 窗口尺寸，--hide-title-bar macOS沉浸式 # 高级用法：自定义选项
pake https://weekly.tw93.fun --name Weekly --icon https://cdn.tw93.fun/pake/weekly.icns --hide-title-bar pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar
``` ```
首次打包需要安装环境会比较慢，后续很快。完整参数说明查看 [CLI 使用指南](docs/cli-usage_CN.md)，不想用命令行可以试试 [GitHub Actions 在线构建](docs/github-actions-usage_CN.md)。 首次打包需要安装环境会比较慢，后续很快。完整参数说明查看 [CLI 使用指南](docs/cli-usage_CN.md)，不想用命令行可以试试 [GitHub Actions 在线构建](docs/github-actions-usage_CN.md)。

10
README_JP.md
View File

@@ -158,14 +158,14 @@
![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif)
```bash ```bash
# インストール # Pake CLIをインストール
pnpm install -g pake-cli pnpm install -g pake-cli
# 基本使用（ウェブサイトのアイコンを自動取得） # 基本使用法 - ウェブサイトのアイコンを自動取得
pake https://weekly.tw93.fun --name Weekly pake https://github.com --name "GitHub"
# よく使うパラメータ：--name アプリ名、--icon カスタムアイコン、--width/--height ウィンドウサイズ、--hide-title-bar macOS没入型 # 高級使用法：カスタムオプション
pake https://weekly.tw93.fun --name Weekly --icon https://cdn.tw93.fun/pake/weekly.icns --hide-title-bar pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar
``` ```
初回パッケージ化は環境設定で時間がかかりますが、その後は高速です。完全なパラメータ説明は[CLI使用ガイド](docs/cli-usage.md)を参照してください。コマンドラインを使いたくない場合は[GitHub Actions オンライン構築](docs/github-actions-usage.md)をお試しください。 初回パッケージ化は環境設定で時間がかかりますが、その後は高速です。完全なパラメータ説明は[CLI使用ガイド](docs/cli-usage.md)を参照してください。コマンドラインを使いたくない場合は[GitHub Actions オンライン構築](docs/github-actions-usage.md)をお試しください。

13
docs/cli-usage.md vendored
View File

@@ -41,20 +41,15 @@ source ~/.bashrc
## Quick Start ## Quick Start
```bash ```bash
# Basic usage - just provide a URL (auto-fetch website icon) # Basic usage - automatically fetches website icon
pake https://weekly.tw93.fun --name "Weekly" pake https://github.com --name "GitHub"
# With custom icon and window size (macOS example) # Advanced usage with custom options
pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar
# macOS immersive experience
pake https://weekly.tw93.fun --name "Weekly" --hide-title-bar
# Complete example with multiple options # Complete example with multiple options
pake https://github.com --name "GitHub Desktop" --width 1400 --height 900 --show-system-tray --debug pake https://github.com --name "GitHub Desktop" --width 1400 --height 900 --show-system-tray --debug
# Privacy-focused app with incognito mode
pake https://duckduckgo.com --name "DuckDuckGo" --incognito --always-on-top
``` ```
## CLI Usage ## CLI Usage

13
docs/cli-usage_CN.md vendored
View File

@@ -41,20 +41,15 @@ source ~/.bashrc
## 快速开始 ## 快速开始
```bash ```bash
# 基础用法 - 只需要提供URL（自动获取网站图标） # 基础用法 - 自动获取网站图标
pake https://weekly.tw93.fun --name "Weekly" pake https://github.com --name "GitHub"
# 自定义图标和窗口大小（macOS示例） # 高级用法：自定义选项
pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar
# macOS 沉浸式体验
pake https://weekly.tw93.fun --name "Weekly" --hide-title-bar
# 完整示例：多个选项组合使用 # 完整示例：多个选项组合使用
pake https://github.com --name "GitHub Desktop" --width 1400 --height 900 --show-system-tray --debug pake https://github.com --name "GitHub Desktop" --width 1400 --height 900 --show-system-tray --debug
# 注重隐私的应用：隐身模式
pake https://duckduckgo.com --name "DuckDuckGo" --incognito --always-on-top
``` ```
## 命令行使用 ## 命令行使用