From c097f90006ffda0b5cc78e006f4e5e945cc53b9c Mon Sep 17 00:00:00 2001 From: Tw93 Date: Sun, 7 Sep 2025 08:31:38 +0800 Subject: [PATCH] :pencil: Documentation is clearer --- README.md | 10 +++++----- README_CN.md | 10 +++++----- README_JP.md | 10 +++++----- docs/cli-usage.md | 13 ++++--------- docs/cli-usage_CN.md | 13 ++++--------- 5 files changed, 23 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 877228d..84f8511 100644 --- a/README.md +++ b/README.md @@ -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) ```bash -# Install +# Install Pake CLI pnpm install -g pake-cli -# Basic usage (auto-fetch website icon) -pake https://weekly.tw93.fun --name Weekly +# Basic usage - automatically fetches website icon +pake https://github.com --name "GitHub" -# Common options: --name app name, --icon custom icon, --width/--height window size, --hide-title-bar macOS immersive -pake https://weekly.tw93.fun --name Weekly --icon https://cdn.tw93.fun/pake/weekly.icns --hide-title-bar +# Advanced usage with custom options +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). diff --git a/README_CN.md b/README_CN.md index bdec7ea..a2df68f 100644 --- a/README_CN.md +++ b/README_CN.md @@ -159,14 +159,14 @@ ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) ```bash -# 安装 +# 安装 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)。 diff --git a/README_JP.md b/README_JP.md index 0db726a..750d69c 100644 --- a/README_JP.md +++ b/README_JP.md @@ -158,14 +158,14 @@ ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) ```bash -# インストール +# 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)をお試しください。 diff --git a/docs/cli-usage.md b/docs/cli-usage.md index 33305f4..ba24101 100644 --- a/docs/cli-usage.md +++ b/docs/cli-usage.md @@ -41,20 +41,15 @@ source ~/.bashrc ## Quick Start ```bash -# Basic usage - just provide a URL (auto-fetch website icon) -pake https://weekly.tw93.fun --name "Weekly" +# Basic usage - automatically fetches website icon +pake https://github.com --name "GitHub" -# With custom icon and window size (macOS example) -pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 - -# macOS immersive experience -pake https://weekly.tw93.fun --name "Weekly" --hide-title-bar +# Advanced usage with custom options +pake https://weekly.tw93.fun --name "Weekly" --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar # Complete example with multiple options 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 diff --git a/docs/cli-usage_CN.md b/docs/cli-usage_CN.md index 0800006..d50a0fb 100644 --- a/docs/cli-usage_CN.md +++ b/docs/cli-usage_CN.md @@ -41,20 +41,15 @@ source ~/.bashrc ## 快速开始 ```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 - -# macOS 沉浸式体验 -pake https://weekly.tw93.fun --name "Weekly" --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 # 完整示例:多个选项组合使用 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 ``` ## 命令行使用