📝 Documentation is clearer
This commit is contained in:
62
README.md
62
README.md
@@ -3,7 +3,7 @@
|
||||
<img src=https://gw.alipayobjects.com/zos/k/fa/logo-modified.png width=138/>
|
||||
</p>
|
||||
<h1 align="center">Pake</h1>
|
||||
<p align="center"><strong>Turn any webpage into a desktop app with Rust <em>with ease</em>.</strong></p>
|
||||
<p align="center"><strong>Turn any webpage into a desktop app with Rust, supports Mac | Windows | Linux</strong></p>
|
||||
<div align="center">
|
||||
<a href="https://twitter.com/HiTw93" target="_blank">
|
||||
<img alt="twitter" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter"></a>
|
||||
@@ -15,19 +15,20 @@
|
||||
<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=sharing" target="_blank">
|
||||
<img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"></a>
|
||||
</div>
|
||||
|
||||
<div align="left">Pake supports Mac, Windows, and Linux. Check out README for <a href="#popular-packages">Popular Packages</a>, <a href="#command-line-packaging">Command-Line Packaging</a>, and <a href="#development">Customized Development</a> information. Feel free to share your suggestions in <a href=https://github.com/tw93/Pake/discussions>Discussions</a>.</div>
|
||||
|
||||
## Features
|
||||
|
||||
- 🎐 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.
|
||||
- 🖱️ Smart right-click context menus with download support for images, videos, and files.
|
||||
- 👻 Pake is just a simple tool — replaces the old bundle approach with Tauri (though PWA is also a good alternative).
|
||||
- 🎐 **Lightweight**: Nearly 20 times smaller than Electron packages, typically around 5M
|
||||
- 🚀 **Fast**: Built with Rust Tauri, much faster than traditional JS frameworks with lower memory usage
|
||||
- ⚡ **Easy to use**: One-command packaging via CLI or online building, no complex configuration needed
|
||||
- 📦 **Feature-rich**: Supports shortcut pass-through, immersive windows, drag & drop, style customization, ad removal
|
||||
|
||||
## Getting Started
|
||||
|
||||
- **Beginners**: Download ready-made [Popular Packages](#popular-packages) or use [Online Building](docs/github-actions-usage.md) with no environment setup required
|
||||
- **Developers**: Install [CLI Tool](docs/cli-usage.md) for one-command packaging of any website with customizable icons, window settings, and more
|
||||
- **Advanced Users**: Clone the project locally for [Custom Development](#development), or check [Advanced Usage](docs/advanced-usage.md) for style customization and feature enhancement
|
||||
|
||||
## Popular Packages
|
||||
|
||||
@@ -152,58 +153,39 @@ In addition, double-click the title bar to switch to full-screen mode. For Mac u
|
||||
|
||||
</details>
|
||||
|
||||
## Before starting
|
||||
|
||||
1. **For beginners**: Play with Popular Packages to find out Pake's capabilities, or try to pack your application with [GitHub Actions](docs/github-actions-usage.md). Don't hesitate to reach for assistance at [Discussion](https://github.com/tw93/Pake/discussions)!
|
||||
2. **For developers**: “Command-Line Packaging” supports macOS fully. For Windows/Linux users, it requires some tinkering. [Configure your environment](https://tauri.app/start/prerequisites/) before getting started.
|
||||
3. **For hackers**: For people who are good at both front-end development and Rust, how about customizing your apps' function more with the following [Customized Development](#development)?
|
||||
|
||||
## Command-Line Packaging
|
||||
|
||||

|
||||
|
||||
**Pake provides a command line tool, making the flow of package customization quicker and easier. See the [CLI usage guide](docs/cli-usage.md) for more information.**
|
||||
|
||||
```bash
|
||||
# Recommended (pnpm)
|
||||
# Install
|
||||
pnpm install -g pake-cli
|
||||
|
||||
# Alternative (npm)
|
||||
npm install -g pake-cli
|
||||
# Basic usage
|
||||
pake https://weekly.tw93.fun --name Weekly
|
||||
|
||||
# Command usage
|
||||
pake url [OPTIONS]...
|
||||
|
||||
# Feel free to play with Pake! It might take a while to prepare the environment the first time you launch Pake.
|
||||
pake https://weekly.tw93.fun --name Weekly --hide-title-bar
|
||||
# Common options: --name app name, --icon 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
|
||||
```
|
||||
|
||||
If you are new to the command line, you can compile packages online with _GitHub Actions_. See our [documentation](#documentation) for detailed guides.
|
||||
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).
|
||||
|
||||
## Development
|
||||
|
||||
Prepare your environment before starting. Make sure you have Rust `>=1.89` and Node `>=18` (e.g., `22.11.0`) installed on your computer. _Note: Latest stable versions are recommended._ For installation guidance, see [Tauri documentation](https://tauri.app/start/prerequisites/).
|
||||
Requires Rust `>=1.89` and Node `>=22`. For detailed installation guide, see [Tauri documentation](https://tauri.app/start/prerequisites/). If unfamiliar with development environment, use the CLI tool instead.
|
||||
|
||||
If you are unfamiliar with these, it is better to try out the above tool to pack with one click.
|
||||
|
||||
```sh
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm i
|
||||
|
||||
# Local development (right-click to open debug mode)
|
||||
# Local development [right-click to open debug mode]
|
||||
pnpm run dev
|
||||
|
||||
# Build application
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[CLI Usage](docs/cli-usage.md)** | [中文](docs/cli-usage_CN.md) - Command-line interface reference
|
||||
- **[Advanced Usage](docs/advanced-usage.md)** | [中文](docs/advanced-usage_CN.md) - Customization and advanced features
|
||||
- **[GitHub Actions](docs/github-actions-usage.md)** | [中文](docs/github-actions-usage_CN.md) - Build apps online
|
||||
- **[Pake Action](docs/pake-action.md)** - Use Pake as GitHub Action in your projects
|
||||
- **[Contributing](CONTRIBUTING.md)** - How to contribute to development
|
||||
For style customization, feature enhancement, container communication and other advanced features, see [Advanced Usage Documentation](docs/advanced-usage.md).
|
||||
|
||||
## Developers
|
||||
|
||||
@@ -548,6 +530,6 @@ Pake's development can not be without these Hackers. They contributed a lot of c
|
||||
## Support
|
||||
|
||||
1. I have two cats, TangYuan and Coke. If you think Pake delights your life, you can feed them <a href="https://miaoyan.app/cats.html?name=Pake" target="_blank">some canned food 🥩</a>.
|
||||
2. If you like Pake, you can star it on GitHub. Also, welcome to [recommend Pake](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20-%20A%20simple%20Rust%20packaged%20web%20pages%20to%20generate%20Mac%20App%20tool,%20compared%20to%20traditional%20Electron%20package,%20the%20size%20of%20nearly%2040%20times%20smaller,%20generally%20about%202M,%20the%20underlying%20use%20of%20Tauri,%20performance%20experience%20than%20the%20JS%20framework%20is%20much%20lighter~) to your friends.
|
||||
2. If you like Pake, you can star it on GitHub. Also, welcome to [recommend Pake](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=Pake%20-%20Turn%20any%20webpage%20into%20a%20desktop%20app%20with%20Rust.%20Nearly%2020x%20smaller%20than%20Electron%20packages,%20supports%20Mac%20Windows%20Linux) to your friends.
|
||||
3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake or join our [Telegram](https://t.me/+GclQS9ZnxyI2ODQ1) chat group.
|
||||
4. I hope that you enjoy playing with it. Let us know if you find a website that would be great for a Mac App!
|
||||
|
||||
68
README_CN.md
68
README_CN.md
@@ -3,7 +3,7 @@
|
||||
<img src=https://gw.alipayobjects.com/zos/k/fa/logo-modified.png width=138/>
|
||||
</p>
|
||||
<h1 align="center">Pake</h1>
|
||||
<p align="center"><strong>利用 Rust 轻松构建轻量级多端桌面应用</strong></p>
|
||||
<p align="center"><strong>用 Rust 打包网页生成轻量桌面应用,支持 Mac | Windows | Linux</strong></p>
|
||||
<div align="center">
|
||||
<a href="https://twitter.com/HiTw93" target="_blank">
|
||||
<img alt="twitter" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter"></a>
|
||||
@@ -15,18 +15,20 @@
|
||||
<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=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>
|
||||
|
||||
## 特征
|
||||
|
||||
- 🎐 相比传统的 Electron 套壳打包,要小将近 20 倍,5M 上下。
|
||||
- 🚀 Pake 的底层使用的 Rust Tauri 框架,性能体验较 JS 框架要轻快不少,内存小很多。
|
||||
- 📦 不是单纯打包,实现了快捷键透传、沉浸式窗口、拖动、样式改写、去广告、产品极简风格定制。
|
||||
- 🖱️ 智能右键菜单,支持图片、视频、文件的下载和操作功能。
|
||||
- 👻 只是一个很简单的小玩具,用 Tauri 替代之前套壳网页打包的老思路,其实 PWA 也很好。
|
||||
- 🎐 **体积小巧**:相比 Electron 应用小近 20 倍,通常只有 5M 左右
|
||||
- 🚀 **性能优异**:基于 Rust Tauri,比传统 JS 框架更快,内存占用更少
|
||||
- ⚡ **使用简单**:命令行一键打包,或在线构建,无需复杂配置
|
||||
- 📦 **功能丰富**:支持快捷键透传、沉浸式窗口、拖拽、样式定制、去广告
|
||||
|
||||
## 快速开始
|
||||
|
||||
- **新手用户**:直接下载现成的 [常用包](#常用包下载),或通过 [在线构建](docs/github-actions-usage_CN.md) 无需环境配置即可打包
|
||||
- **开发者**:安装 [CLI 工具](docs/cli-usage_CN.md) 后一行命令打包任意网站,支持自定义图标、窗口等参数
|
||||
- **高级用户**:本地克隆项目进行 [定制开发](#定制开发),或查看 [高级用法](docs/advanced-usage_CN.md) 实现样式定制、功能增强
|
||||
|
||||
## 常用包下载
|
||||
|
||||
@@ -148,45 +150,32 @@
|
||||
| <kbd>⌘</kbd> + <kbd>=</kbd> | <kbd>Ctrl</kbd> + <kbd>=</kbd> | 放大页面 |
|
||||
| <kbd>⌘</kbd> + <kbd>0</kbd> | <kbd>Ctrl</kbd> + <kbd>0</kbd> | 重置页面缩放 |
|
||||
|
||||
此外还支持双击头部进行全屏切换,拖拽头部进行移动窗口,Mac 用户支持手势方式返回和去下一页,还有其他需求,欢迎提过来。
|
||||
此外还支持双击头部全屏切换,拖拽头部移动窗口,Mac 用户支持手势返回和前进,有其他需求欢迎提出。
|
||||
|
||||
</details>
|
||||
|
||||
## 开始之前
|
||||
|
||||
1. **小白用户**:使用 「常用包下载」 方式来把玩 Pake 的能力,可去 [讨论群](https://github.com/tw93/Pake/discussions) 寻求帮助,也可试试 [Action](https://github.com/tw93/Pake/wiki/%E5%9C%A8%E7%BA%BF%E7%BC%96%E8%AF%91%EF%BC%88%E6%99%AE%E9%80%9A%E7%94%A8%E6%88%B7%E4%BD%BF%E7%94%A8%EF%BC%89) 方式。
|
||||
2. **开发用户**:使用 「命令行一键打包」,对 Mac 比较友好,Windows / Linux 需折腾下 [环境配置](https://tauri.app/start/prerequisites/)。
|
||||
3. **折腾用户**:假如你前端和 Rust 都会,那可试试下面的 「[定制开发](#定制开发)」,可深度二次开发定制你的功能。
|
||||
|
||||
## 命令行一键打包
|
||||
|
||||

|
||||
|
||||
**Pake 提供了命令行工具,可以更快捷方便地一键自定义打包你需要的应用,详细可见 [CLI 使用指南](docs/cli-usage_CN.md)。**
|
||||
|
||||
```bash
|
||||
# 推荐方式 (pnpm)
|
||||
# 安装
|
||||
pnpm install -g pake-cli
|
||||
|
||||
# 备选方式 (npm)
|
||||
npm install -g pake-cli
|
||||
# 基础使用
|
||||
pake https://weekly.tw93.fun --name Weekly
|
||||
|
||||
# 命令使用
|
||||
pake url [OPTIONS]...
|
||||
|
||||
# 试试看!首次打包可能较慢(需要安装环境),后续会很快
|
||||
pake https://weekly.tw93.fun --name Weekly --hide-title-bar
|
||||
# 常用参数:--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
|
||||
```
|
||||
|
||||
如果你不太会使用命令行,可以使用 **GitHub Actions 在线编译**,详细步骤请参考[文档](#文档)。
|
||||
首次打包需要安装环境会比较慢,后续很快。完整参数说明查看 [CLI 使用指南](docs/cli-usage_CN.md),不想用命令行可以试试 [GitHub Actions 在线构建](docs/github-actions-usage_CN.md)。
|
||||
|
||||
## 定制开发
|
||||
|
||||
开始前请确保电脑已经安装了 Rust `>=1.89` 和 Node `>=18`(如 22.11.0)的环境。_注意:推荐使用最新稳定版本。_ 详细安装指南请参考 [Tauri 文档](https://tauri.app/start/prerequisites/)。
|
||||
需要 Rust `>=1.89` 和 Node `>=22`,详细安装指南参考 [Tauri 文档](https://tauri.app/start/prerequisites/)。不熟悉开发环境建议直接使用命令行工具。
|
||||
|
||||
如果您对这些不熟悉,建议使用上面的命令行工具进行一键打包。
|
||||
|
||||
```sh
|
||||
```bash
|
||||
# 安装依赖
|
||||
pnpm i
|
||||
|
||||
@@ -195,20 +184,13 @@ pnpm run dev
|
||||
|
||||
# 打包应用
|
||||
pnpm run build
|
||||
|
||||
```
|
||||
|
||||
## 文档
|
||||
|
||||
- **[CLI 使用指南](docs/cli-usage_CN.md)** - 命令行接口参考
|
||||
- **[高级用法指南](docs/advanced-usage_CN.md)** - 自定义和高级功能
|
||||
- **[GitHub Actions 指南](docs/github-actions-usage_CN.md)** - 在线构建应用
|
||||
- **[Pake Action](docs/pake-action.md)** - 在你的项目中使用 Pake Action
|
||||
- **[贡献指南](CONTRIBUTING.md)** - 如何参与开发
|
||||
想要样式定制、功能增强、容器通信等高级玩法,查看 [高级用法文档](docs/advanced-usage_CN.md)。
|
||||
|
||||
## 开发者
|
||||
|
||||
Pake 的发展离不开这些 Hacker 们,一起贡献了大量能力,也欢迎关注他们 ❤️
|
||||
Pake 的发展离不开这些优秀的贡献者 ❤️
|
||||
|
||||
<!-- readme: contributors -start -->
|
||||
<table>
|
||||
@@ -549,6 +531,6 @@ Pake 的发展离不开这些 Hacker 们,一起贡献了大量能力,也欢
|
||||
## 支持
|
||||
|
||||
1. 我有两只猫,一只叫汤圆,一只可乐,假如 Pake 让你生活更美好,可以给她们 <a href="https://miaoyan.app/cats.html?name=Pake" target="_blank">喂罐头 🥩</a>。
|
||||
2. 如果你喜欢 Pake,可以在 Github Star,更欢迎 [推荐](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20%E4%B8%80%E4%B8%AA%E5%BE%88%E7%AE%80%E5%8D%95%E7%9A%84%E7%94%A8%20Rust%20%E6%89%93%E5%8C%85%E7%BD%91%E9%A1%B5%E7%94%9F%E6%88%90%20Mac%20App%20%E7%9A%84%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%9B%B8%E6%AF%94%E4%BC%A0%E7%BB%9F%E7%9A%84%20Electron%20%E5%A5%97%E5%A3%B3%E6%89%93%E5%8C%85%EF%BC%8C%E5%A4%A7%E5%B0%8F%E8%A6%81%E5%B0%8F%E5%B0%86%E8%BF%91%2040%20%E5%80%8D%EF%BC%8C%E4%B8%80%E8%88%AC%202M%20%E5%B7%A6%E5%8F%B3%EF%BC%8C%E5%BA%95%E5%B1%82%E4%BD%BF%E7%94%A8Tauri%20%EF%BC%8C%E6%80%A7%E8%83%BD%E4%BD%93%E9%AA%8C%E8%BE%83%20JS%20%E6%A1%86%E6%9E%B6%E8%A6%81%E8%BD%BB%E5%BF%AB%E4%B8%8D%E5%B0%91%EF%BC%8C%E5%86%85%E5%AD%98%E5%B0%8F%E5%BE%88%E5%A4%9A%EF%BC%8C%E6%94%AF%E6%8C%81%E5%BE%AE%E4%BF%A1%E8%AF%BB%E4%B9%A6%E3%80%81Twitter%E3%80%81Youtube%E3%80%81RunCode%E3%80%81Flomo%E3%80%81%E8%AF%AD%E9%9B%80%E7%AD%89%EF%BC%8C%E5%8F%AF%E4%BB%A5%E5%BE%88%E6%96%B9%E4%BE%BF%E4%BA%8C%E6%AC%A1%E5%BC%80%E5%8F%91~) 给你志同道合的朋友使用。
|
||||
3. 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取到最新的 Pake 更新消息,也欢迎加入 [Telegram](https://t.me/+GclQS9ZnxyI2ODQ1) 聊天群。
|
||||
4. 希望大伙玩的过程中有一种学习新技术的喜悦感,假如你发现有很适合做成桌面 App 的网页也很欢迎告诉我。
|
||||
2. 如果你喜欢 Pake,可以在 Github Star,更欢迎 [推荐](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=Pake%20-%20用%20Rust%20打包网页生成轻量桌面应用,比%20Electron%20小%2020%20倍,支持%20Mac%20Windows%20Linux) 给志同道合的朋友使用。
|
||||
3. 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取最新的 Pake 更新消息,也欢迎加入 [Telegram](https://t.me/+GclQS9ZnxyI2ODQ1) 聊天群。
|
||||
4. 希望大伙玩的过程中有一种学习新技术的喜悦感,发现适合做成桌面 App 的网页也欢迎告诉我。
|
||||
|
||||
61
README_JP.md
61
README_JP.md
@@ -3,7 +3,7 @@
|
||||
<img src=https://gw.alipayobjects.com/zos/k/fa/logo-modified.png width=138/>
|
||||
</p>
|
||||
<h1 align="center">Pake</h1>
|
||||
<p align="center"><strong>Rustを使って、簡単にウェブページをデスクトップアプリに変換します。</strong></p>
|
||||
<p align="center"><strong>Rustでウェブページをデスクトップアプリにパッケージ化、Mac | Windows | Linux対応</strong></p>
|
||||
<div align="center">
|
||||
<a href="https://twitter.com/HiTw93" target="_blank">
|
||||
<img alt="twitter" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter"></a>
|
||||
@@ -15,19 +15,20 @@
|
||||
<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=sharing" target="_blank">
|
||||
<img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"></a>
|
||||
</div>
|
||||
|
||||
<div align="left">PakeはMac、Windows、Linuxをサポートしています。<a href="#人気のパッケージ">人気のパッケージ</a>、<a href="#コマンドラインパッケージング">コマンドラインパッケージング</a>、<a href="#開発">カスタマイズ開発</a>に関する情報はREADMEをご覧ください。<a href=https://github.com/tw93/Pake/discussions>ディスカッション</a>でご意見をお聞かせください。</div>
|
||||
|
||||
## 特徴
|
||||
|
||||
- 🎐 Electron パッケージと比較して約 20 倍小さい(約 5M!)
|
||||
- 🚀 Rust Tauri を使用しているため、Pake は JS ベースのフレームワークよりもはるかに軽量で高速です。
|
||||
- 📦 パッケージにはショートカットの透過、没入型ウィンドウ、ミニマリストのカスタマイズが含まれています。
|
||||
- 🖱️ 画像、動画、ファイルのダウンロードをサポートするスマートな右クリックコンテキストメニュー。
|
||||
- 👻 Pake は単なるシンプルなツールです — Tauri を使用して古いバンドルアプローチを置き換えます(PWA も十分に良い代替手段です)。
|
||||
- 🎐 **軽量**: Electronより約20倍小さく、通常約5M
|
||||
- 🚀 **高速**: Rust Tauriベースで、従来のJSフレームワークより高速、メモリ使用量も少ない
|
||||
- ⚡ **使いやすい**: CLIでワンコマンドパッケージング、複雑な設定不要
|
||||
- 📦 **高機能**: ショートカット透過、没入型ウィンドウ、ドラッグ&ドロップ、スタイルカスタマイズをサポート
|
||||
|
||||
## 快速開始
|
||||
|
||||
- **初心者**: 既成の[人気パッケージ](#人気のパッケージ)をダウンロード、または[オンライン構築](docs/github-actions-usage.md)で環境設定なしでパッケージ化
|
||||
- **開発者**: [CLIツール](docs/cli-usage.md)インストール後、ワンコマンドで任意のウェブサイトをパッケージ化、アイコンやウィンドウなどのパラメータをカスタマイズ可能
|
||||
- **上級者**: プロジェクトをローカルクローンして[カスタム開発](#開発)、または[高級用法](docs/advanced-usage.md)でスタイルカスタマイズ・機能拡張を実現
|
||||
|
||||
## 人気のパッケージ
|
||||
|
||||
@@ -152,57 +153,39 @@
|
||||
|
||||
</details>
|
||||
|
||||
## 始める前に
|
||||
|
||||
1. **初心者の方へ**: 「人気のパッケージ」を使用して Pake の機能を試してみてください。または、[GitHub Actions](docs/github-actions-usage.md)を使用してアプリケーションをパッケージ化してみてください。[ディスカッション](https://github.com/tw93/Pake/discussions)で助けを求めることもできます!
|
||||
2. **開発者の方へ**: 「コマンドラインパッケージング」を使用してください。macOS では完全にサポートされています。Windows/Linux ユーザーは、[環境を設定](https://tauri.app/start/prerequisites/)する必要があります。
|
||||
3. **ハッカーの方へ**: フロントエンド開発と Rust の両方が得意な方は、以下の[カスタマイズ開発](#開発)でアプリの機能をさらにカスタマイズしてみてください。
|
||||
|
||||
## コマンドラインパッケージング
|
||||
|
||||

|
||||
|
||||
**Pake はコマンドラインツールを提供しており、必要なパッケージをより迅速かつ簡単にカスタマイズすることができます。詳細は[CLI使用ガイド](docs/cli-usage.md)をご覧ください。**
|
||||
|
||||
```bash
|
||||
# 推奨方法 (pnpm)
|
||||
# インストール
|
||||
pnpm install -g pake-cli
|
||||
|
||||
# 代替方法 (npm)
|
||||
npm install -g pake-cli
|
||||
# 基本使用
|
||||
pake https://weekly.tw93.fun --name Weekly
|
||||
|
||||
# コマンドの使用
|
||||
pake url [OPTIONS]...
|
||||
|
||||
# Pakeを自由に試してみてください!初めての起動時は環境の準備に時間がかかる場合があります。
|
||||
pake https://weekly.tw93.fun --name Weekly --hide-title-bar
|
||||
# よく使うパラメータ:--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
|
||||
```
|
||||
|
||||
コマンドラインの使用に不慣れな場合は、_GitHub Actions_ を使用してオンラインでパッケージをコンパイルすることができます。詳細な手順については [GitHub Actions 使用ガイド](docs/github-actions-usage.md) をご覧ください。
|
||||
初回パッケージ化は環境設定で時間がかかりますが、その後は高速です。完全なパラメータ説明は[CLI使用ガイド](docs/cli-usage.md)を参照してください。コマンドラインを使いたくない場合は[GitHub Actions オンライン構築](docs/github-actions-usage.md)をお試しください。
|
||||
|
||||
## 開発
|
||||
|
||||
開始する前に、Rust `>=1.89` と Node `>=18`(例:22.11.0)がコンピュータにインストールされていることを確認してください。_注意:最新の安定版の使用をお勧めします。_ インストールガイドについては、[Tauri ドキュメント](https://tauri.app/start/prerequisites/)を参照してください。
|
||||
Rust `>=1.89` と Node `>=22` が必要です。詳細なインストールガイドは[Tauriドキュメント](https://tauri.app/start/prerequisites/)を参照してください。開発環境に不慣れな場合は、直接コマンドラインツールの使用をお勧めします。
|
||||
|
||||
これらに不慣れな場合は、上記のツールを使用してワンクリックでパッケージを作成することをお勧めします。
|
||||
|
||||
```sh
|
||||
```bash
|
||||
# 依存関係のインストール
|
||||
pnpm i
|
||||
|
||||
# ローカル開発(右クリックでデバッグモードを開く)
|
||||
# ローカル開発[右クリックでデバッグモード開可]
|
||||
pnpm run dev
|
||||
|
||||
# アプリケーションのビルド
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
## 高度な使用法
|
||||
|
||||
1. [CONTRIBUTING.md](CONTRIBUTING.md#project-structure)のコードベース構造を参照して、開発前により多くの情報を得ることができます。
|
||||
2. `src-tauri` ディレクトリ内の `pake.json` ファイルの `url` と `productName` フィールドを変更する場合は、`tauri.config.json` ファイル内の `domain` フィールド、および `tauri.xxx.conf.json` ファイル内の `icon` と `identifier` フィールドを同期して変更する必要があります。`icon` は `icons` ディレクトリから選択することも、[macOSicons](https://macosicons.com/#/) から効果に合ったものをダウンロードすることもできます。
|
||||
3. ウィンドウプロパティの設定については、`pake.json` ファイルを変更して `windows` プロパティの `width`、`height`、`fullscreen`(またはしない)、`resizable`(またはしない)の値を変更できます。Mac の没入型ヘッダーに適応するには、`hideTitleBar` を `true` に設定し、`Header` 要素を見つけて `padding-top` プロパティを追加します。
|
||||
4. スタイルの書き換え、広告の除去、JS の注入、コンテナメッセージ通信、ユーザー定義のショートカットキーについては、[高度な使用法](docs/advanced-usage.md)を参照してください。
|
||||
スタイルカスタマイズ、機能拡張、コンテナ通信などの高度な機能については、[高級使用法ドキュメント](docs/advanced-usage.md)を参照してください。
|
||||
|
||||
## 開発者
|
||||
|
||||
@@ -547,6 +530,6 @@ Pake の開発はこれらのハッカーたちなしにはあり得ませんで
|
||||
## サポート
|
||||
|
||||
1. 私には汤圆と可乐という 2 匹の猫がいます。Pake があなたの生活をより良くしてくれると思ったら、<a href="https://miaoyan.app/cats.html?name=Pake" target="_blank">缶詰をあげてください 🥩</a>。
|
||||
2. Pake が気に入ったら、GitHub でスターをつけてください。また、友達に<a href="https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20-%20Rust%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%80%81%E7%B0%A1%E5%8D%98%E3%81%AB%E3%82%A6%E3%82%A7%E3%83%96%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E3%83%87%E3%82%B9%E3%82%AF%E3%83%88%E3%83%83%E3%83%97%E3%82%A2%E3%83%97%E3%83%AA%E3%81%AB%E5%A4%89%E6%8F%9B%E3%81%99%E3%82%8B%E3%83%84%E3%83%BC%E3%83%AB%E3%80%82Electron%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E3%81%A8%E6%AF%94%E8%BC%83%E3%81%97%E3%81%A6%E3%80%81%E7%B4%84%2040%E5%80%8D%E5%B0%8F%E3%81%95%E3%81%84%E3%80%81%E4%B8%80%E8%88%AC%E7%B4%842M%E3%80%81Tauri%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E3%81%9F%E3%82%81%E3%80%81JS%E3%83%95%E3%83%AC%E3%83%BC%E3%83%A0%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%88%E3%82%8A%E3%82%82%E3%81%AF%E3%82%8B%E3%81%8B%E3%81%AB%E8%BB%BD%E9%87%8F%E3%81%A7%E9%AB%98%E9%80%9F%E3%81%A7%E3%81%99%E3%80%82">推薦</a>することを歓迎します。
|
||||
2. Pake が気に入ったら、GitHub でスターをつけてください。また、友達に<a href="https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=Pake%20-%20Rust%E3%81%A7%E3%82%A6%E3%82%A7%E3%83%96%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E3%83%87%E3%82%B9%E3%82%AF%E3%83%88%E3%83%83%E3%83%97%E3%82%A2%E3%83%97%E3%83%AA%E3%81%AB%E5%A4%89%E6%8F%9B%E3%80%81Electron%E3%82%88%E3%82%8A20%E5%80%8D%E5%B0%8F%E3%81%95%E3%81%84%E3%80%81Mac%20Windows%20Linux%E5%AF%BE%E5%BF%9C">推薦</a>することを歓迎します。
|
||||
3. 私の<a href="https://twitter.com/HiTw93">Twitter</a>をフォローして、Pake の最新情報を入手することができます。また、<a href="https://t.me/+GclQS9ZnxyI2ODQ1">Telegram</a>のチャットグループに参加することもできます。
|
||||
4. 皆さんが楽しんでいただけることを願っています。Mac アプリに適したウェブサイトを見つけたら、ぜひ教えてください。
|
||||
|
||||
Reference in New Issue
Block a user