📝 Document usage is more idiomatic
This commit is contained in:
Tw93
4
.github/workflows/update-contributors.yml
vendored
4
.github/workflows/update-contributors.yml
vendored
@@ -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 }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
@@ -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 @@
|
||||
| <kbd>⌘</kbd> + <kbd>↑</kbd> | <kbd>Ctrl</kbd> + <kbd>↑</kbd> | Auto scroll to top of page |
|
||||
| <kbd>⌘</kbd> + <kbd>↓</kbd> | <kbd>Ctrl</kbd> + <kbd>↓</kbd> | Auto scroll to bottom of page |
|
||||
| <kbd>⌘</kbd> + <kbd>r</kbd> | <kbd>Ctrl</kbd> + <kbd>r</kbd> | Refresh Page |
|
||||
| <kbd>⌘</kbd> + <kbd>w</kbd> | <kbd>Ctrl</kbd> + <kbd>w</kbd> | Hide window, not quite |
|
||||
| <kbd>⌘</kbd> + <kbd>w</kbd> | <kbd>Ctrl</kbd> + <kbd>w</kbd> | Hide window, not quit |
|
||||
| <kbd>⌘</kbd> + <kbd>-</kbd> | <kbd>Ctrl</kbd> + <kbd>-</kbd> | Zoom out the page |
|
||||
| <kbd>⌘</kbd> + <kbd>+</kbd> | <kbd>Ctrl</kbd> + <kbd>+</kbd> | Zoom in the page |
|
||||
| <kbd>⌘</kbd> + <kbd>=</kbd> | <kbd>Ctrl</kbd> + <kbd>=</kbd> | 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 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
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
<img alt="GitHub commit" src="https://img.shields.io/github/commit-activity/m/tw93/Pake?style=flat-square"></a>
|
||||
<a href="https://github.com/tw93/Pake/issues?q=is%3Aissue+is%3Aclosed" target="_blank">
|
||||
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/tw93/Pake.svg?style=flat-square"></a>
|
||||
<a href="https://colab.research.google.com/drive/1bX345znvDZ30848xjRtpgtU8eypWwXrp?usp=sharingg" target="_blank">
|
||||
<a href="https://colab.research.google.com/drive/1bX345znvDZ30848xjRtpgtU8eypWwXrp?usp=sharing" target="_blank">
|
||||
<img alt="在 Colab 中打开" src="https://colab.research.google.com/assets/colab-badge.svg"></a>
|
||||
</div>
|
||||
<div align="left">支持 Mac / Windows / Linux，关于 <a href="#常用包下载">常用包下载</a>、<a href="#命令行一键打包">命令行一键打包</a>、<a href="#定制开发">定制开发</a> 可见下面文档，也欢迎去 <a href=https://github.com/tw93/Pake/discussions>讨论区</a> 交流。</div>
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
- 🎐 相比传统的 Electron 套壳打包，要小将近 20 倍，5M 上下。
|
||||
- 🚀 Pake 的底层使用的 Rust Tauri 框架，性能体验较 JS 框架要轻快不少，内存小很多。
|
||||
- 📦 不是单纯打包，实现了快捷键的透传、沉浸式的窗口、拖动、样式改写、去广告、产品的极简风格定制。
|
||||
- 📦 不是单纯打包，实现了快捷键透传、沉浸式窗口、拖动、样式改写、去广告、产品极简风格定制。
|
||||
- 👻 只是一个很简单的小玩具，用 Tauri 替代之前套壳网页打包的老思路，其实 PWA 也很好。
|
||||
|
||||
## 常用包下载
|
||||
@@ -161,7 +161,7 @@
|
||||
|
||||
|
||||
|
||||
**Pake 提供了命令行工具，可以更快捷方便地一键自定义打你需要的包，详细可见 [文档](./bin/README_CN.md)。**
|
||||
**Pake 提供了命令行工具，可以更快捷方便地一键自定义打包你需要的应用，详细可见 [文档](./bin/README_CN.md)。**
|
||||
|
||||
```bash
|
||||
# 使用 npm 进行安装
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
- 🎐 Electron パッケージと比較して約 20 倍小さい（約 5M！）
|
||||
- 🚀 Rust Tauri を使用しているため、Pake は JS ベースのフレームワークよりもはるかに軽量で高速です。
|
||||
- 📦 パッケージにはショートカットの透過、没入型ウィンドウ、ミニマリストのカスタマイズが含まれています。
|
||||
- 👻 Pake は単なるシンプルなツールです—Tauri を使用して古いバンドルアプローチを置き換えます（PWA も十分に良いです）。
|
||||
- 👻 Pake は単なるシンプルなツールです — Tauri を使用して古いバンドルアプローチを置き換えます（PWA も十分に良い代替手段です）。
|
||||
|
||||
## 人気のパッケージ
|
||||
|
||||
|
||||
6
bin/README.md
vendored
6
bin/README.md
vendored
@@ -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 <string>
|
||||
@@ -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 <format>
|
||||
@@ -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
|
||||
|
||||
6
bin/README_CN.md
vendored
6
bin/README_CN.md
vendored
@@ -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
|
||||
|
||||
@@ -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 逻辑是否正常工作。
|
||||
|
||||
## 开发建议
|
||||
|
||||
|
||||
Reference in New Issue
Block a user