From 3868e993ce1e39628026380562563b0a37625f67 Mon Sep 17 00:00:00 2001 From: Tw93 Date: Fri, 22 Aug 2025 22:21:54 +0800 Subject: [PATCH] :pencil: Document usage is more idiomatic --- .github/workflows/update-contributors.yml | 4 ++-- README.md | 6 +++--- README_CN.md | 6 +++--- README_JP.md | 2 +- bin/README.md | 6 +++--- bin/README_CN.md | 6 ++---- tests/README.md | 6 +++--- 7 files changed, 17 insertions(+), 19 deletions(-) diff --git a/.github/workflows/update-contributors.yml b/.github/workflows/update-contributors.yml index db282a4..67376d6 100644 --- a/.github/workflows/update-contributors.yml +++ b/.github/workflows/update-contributors.yml @@ -4,7 +4,7 @@ on: push: branches: [main, dev] schedule: - - cron: '0 0 * * 0' # Every Sunday at midnight UTC + - cron: "0 0 * * 0" # Every Sunday at midnight UTC jobs: update-contributors: @@ -46,4 +46,4 @@ jobs: readme_path: README_JP.md auto_detect_branch_protection: false env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 5df9fd3..14e7020 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ - 🎐 Nearly 20 times smaller than an Electron package (around 5M!) - 🚀 With Rust Tauri, Pake is much more lightweight and faster than JS-based frameworks. - 📦 Battery-included package — shortcut pass-through, immersive windows, and minimalist customization. -- 👻 Pake is just a simple tool — replace the old bundle approach with Tauri (though PWA is good enough). +- 👻 Pake is just a simple tool — replaces the old bundle approach with Tauri (though PWA is also a good alternative). ## Popular Packages @@ -141,7 +141,7 @@ | ⌘ + ↑ | Ctrl + ↑ | Auto scroll to top of page | | ⌘ + ↓ | Ctrl + ↓ | Auto scroll to bottom of page | | ⌘ + r | Ctrl + r | Refresh Page | -| ⌘ + w | Ctrl + w | Hide window, not quite | +| ⌘ + w | Ctrl + w | Hide window, not quit | | ⌘ + - | Ctrl + - | Zoom out the page | | ⌘ + + | Ctrl + + | Zoom in the page | | ⌘ + = | Ctrl + = | Zoom in the Page | @@ -161,7 +161,7 @@ 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 provides a command line tool, making the flow of package customization quicker and easier. See [documentation](./bin/README.md) for more information.** +**Pake provides a command line tool, making the flow of package customization quicker and easier. See the [documentation](./bin/README.md) for more information.** ```bash # Install with npm diff --git a/README_CN.md b/README_CN.md index 4d304a8..cffcc21 100644 --- a/README_CN.md +++ b/README_CN.md @@ -15,7 +15,7 @@ GitHub commit GitHub closed issues - + 在 Colab 中打开
支持 Mac / Windows / Linux，关于 常用包下载、命令行一键打包、定制开发 可见下面文档，也欢迎去 讨论区 交流。
@@ -24,7 +24,7 @@ - 🎐 相比传统的 Electron 套壳打包，要小将近 20 倍，5M 上下。 - 🚀 Pake 的底层使用的 Rust Tauri 框架，性能体验较 JS 框架要轻快不少，内存小很多。 -- 📦 不是单纯打包，实现了快捷键的透传、沉浸式的窗口、拖动、样式改写、去广告、产品的极简风格定制。 +- 📦 不是单纯打包，实现了快捷键透传、沉浸式窗口、拖动、样式改写、去广告、产品极简风格定制。 - 👻 只是一个很简单的小玩具，用 Tauri 替代之前套壳网页打包的老思路，其实 PWA 也很好。 ## 常用包下载 @@ -161,7 +161,7 @@ ![Pake](https://raw.githubusercontent.com/tw93/static/main/pake/pake.gif) -**Pake 提供了命令行工具，可以更快捷方便地一键自定义打你需要的包，详细可见 [文档](./bin/README_CN.md)。** +**Pake 提供了命令行工具，可以更快捷方便地一键自定义打包你需要的应用，详细可见 [文档](./bin/README_CN.md)。** ```bash # 使用 npm 进行安装 diff --git a/README_JP.md b/README_JP.md index db0660f..f533da9 100644 --- a/README_JP.md +++ b/README_JP.md @@ -26,7 +26,7 @@ - 🎐 Electron パッケージと比較して約 20 倍小さい（約 5M！） - 🚀 Rust Tauri を使用しているため、Pake は JS ベースのフレームワークよりもはるかに軽量で高速です。 - 📦 パッケージにはショートカットの透過、没入型ウィンドウ、ミニマリストのカスタマイズが含まれています。 -- 👻 Pake は単なるシンプルなツールです—Tauri を使用して古いバンドルアプローチを置き換えます（PWA も十分に良いです）。 +- 👻 Pake は単なるシンプルなツールです — Tauri を使用して古いバンドルアプローチを置き換えます（PWA も十分に良い代替手段です）。 ## 人気のパッケージ diff --git a/bin/README.md b/bin/README.md index 55489fb..2e72ec3 100644 --- a/bin/README.md +++ b/bin/README.md @@ -123,7 +123,7 @@ screen. #### [activation-shortcut] -Set the activation shortcut for the application. Default is ` `, it does not take effect, you can customize the activation shortcut with the following commands, e.g. `CmdOrControl+Shift+P`, use can refer to [available-modifiers](https://www.electronjs.org/docs/latest/api/accelerator#available-modifiers). +Set the activation shortcut for the application. Default is empty, so it does not take effect. You can customize the activation shortcut with the following commands, e.g. `CmdOrControl+Shift+P`. Usage can refer to [available-modifiers](https://www.electronjs.org/docs/latest/api/accelerator#available-modifiers). ```shell --activation-shortcut @@ -188,7 +188,7 @@ Package the application to support both Intel and M1 chips, exclusively for macO #### [targets] -Choose the output package format, supporting `deb`, `appimage`, `rpm`, This option is only applicable to Linux and defaults to `deb`. +Choose the output package format, supporting `deb`, `appimage`, `rpm`. This option is only applicable to Linux and defaults to `deb`. ```shell --targets @@ -290,7 +290,7 @@ Set proxy server for all network requests. Supports HTTP, HTTPS, and SOCKS5. Ava #### [debug] -The typed package has dev-tools for debugging, in addition to outputting more log messages for debugging. +The packaged application has dev-tools for debugging, in addition to outputting more log messages for debugging. ```shell --debug diff --git a/bin/README_CN.md b/bin/README_CN.md index ee3341c..657a41a 100644 --- a/bin/README_CN.md +++ b/bin/README_CN.md @@ -256,9 +256,7 @@ pake [url] [options] #### [use-local-file] -当 `url` 为本地文件路径时，如果启用此选项，则会递归地将 `url` 路径文件所在的文件夹及其所有子文件复 - -制到 Pake 的静态文件夹。默认不启用。 +当 `url` 为本地文件路径时，如果启用此选项，则会递归地将 `url` 路径文件所在的文件夹及其所有子文件复制到 Pake 的静态文件夹。默认不启用。 ```shell --use-local-file @@ -292,7 +290,7 @@ pake [url] [options] #### [debug] -打出来的包具备 deb-tools 的调试模式，此外还会输出更多的日志信息用于调试。 +打出来的包具备 dev-tools 的调试模式，此外还会输出更多的日志信息用于调试。 ```shell --debug diff --git a/tests/README.md b/tests/README.md index 0257222..f660905 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,6 +1,6 @@ # Pake CLI 测试 -统一的 CLI 构建测试套件，验证多平台打包功能。 +统一的 CLI 构建测试套件，用于验证多平台打包功能。 ## 运行测试 @@ -44,7 +44,7 @@ npm test -- --no-build # 跳过构建测试，仅验证核心功能（30秒 ### 真实构建测试（重点） -**macOS**: 🔥 多架构构建（Universal Binary） +**macOS**: 🔥 多架构构建（通用二进制） - 编译 Intel + Apple Silicon 双架构 - 检测 `.app` 文件生成：`GitHubMultiArch.app` @@ -91,7 +91,7 @@ npm test -- --no-build # 跳过构建测试，仅验证核心功能（30秒 node ./tests/release.js ``` -真实构建2个应用包，验证完整的打包流程和release.yml逻辑是否正常工作。 +真实构建2个应用包，验证完整的打包流程和 release.yml 逻辑是否正常工作。 ## 开发建议