From af23291f6a504ea5a112ab20d7354149a5eb3154 Mon Sep 17 00:00:00 2001 From: pan93412 Date: Fri, 20 Jan 2023 13:26:51 +0800 Subject: [PATCH] docs(en): Rewrite --- README.md | 94 ++++++++++++++++++++++++------------------------ bin/README_EN.md | 4 +-- 2 files changed, 48 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 6102215..8312d41 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

Pake

-

Simply make any web page a desktop application using rust.

+

Turn any webpage into a desktop app with Rust with ease.

twitter @@ -17,25 +17,25 @@ GitHub closed issues
-
Support Mac / Windows / Linux, about popular downloads、command line packing、custom development can be found in readme. Welcome to discussions to see if there have anything you're interesting.
+
Pake supports Mac, Windows, and Linux. Check out README for Popular Packages, Command-Line Packaging, and Customized Development information. Feel free to share your suggestions in Discussions
## Features -🏂 **Small**：Nearly 40 times smaller than Electron package, less than 3M. -😂 **Fast**：Using the Rust Tauri, it`s much lighter and faster than JS. -🩴 **Special**：Not just packaged, with shortcut pass-through, immersive windows, minimalist customization. -🐶 **Toy**：Just a simple way to play with Rust instead of the old idea of shelling the web. +🏂 **Small**: Nearly 40 times smaller than an Electron package (less than 3M!) \ +😂 **Fast**: With Rust Tauri, Pake is much more lightweight and faster than JS-based frameworks. \ +🩴 **Special**: Battery-included package — shortcut pass-through, immersive windows, and minimalist customization. \ +🐶 **Toy**: Pake is just a simple tool — replace the old bundle approach with Rust (though PWA is good enough). -## Popular Downloads +## Popular Packages - - - - - - - -
WeRead + WeRead Mac Windows Linux Twitter + Twitter Mac Windows Linux @@ -46,12 +46,12 @@
LiZhi + LiZhi Mac Windows Linux YouTube + YouTube Mac Windows Linux @@ -62,12 +62,12 @@
Qwerty + Qwerty Mac Windows Linux Reference + Reference Mac Windows Linux @@ -78,12 +78,12 @@
Library + Library Mac Windows Linux ChatGPT + ChatGPT Mac Windows Linux @@ -96,7 +96,7 @@
-🏂More applications such as Flomo / YuQue / RunCode can be downloaded from Release, click to expand shortcut descriptions +🏂 You can download more applications (such as Flomo / YuQue / RunCode) from Releases. Click here to expand the shortcuts reference!
@@ -113,67 +113,65 @@ | ⌘ + = | Ctrl + = | Zoom in the Page | | ⌘ + 0 | Ctrl + 0 | Reset the page zoom | -In addition, it supports double-clicking the head to switch to full screen, Mac users support gesture mode to return and go to the next page, and dragging the head to move the window. +In addition, double-click the title bar to switch to full-screen mode. For Mac users, you can also use the gesture to go to the previous or next page and drag the title bar to move the window.
-## Before you start +## Before starting -1. **Beginner users**: Use the 「Download」 method to play with Pake's capabilities, go to discussion groups for help, or try the [Github Actions](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version) method. -2. **Development users**: Use 「command line packing」, Mac friendly, Windows/Linux requires a bit of tinkering, but both require environment [configuration](https://tauri.app/v1/guides/getting-started/prerequisites). -3. **Hacker users**: If you know both front-end and rust, try the following custom development, which allows you to customize your features with deep secondary development. +1. **For beginners**: Play with Popular Packages to find out Pake's capabilities, or try to pack your application with [GitHub Actions](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version). Don't hesitate to reach for assistance at [Discussion](https://github.com/tw93/Pake/discussions)! +2. **For developers**: Packaging with Command-Like Packaging fully supports macOS. For Windows/Linux users, it requires some tinkering. [Configure your environment](https://tauri.app/v1/guides/getting-started/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 packing +## Command-Line Packaging - - - -

+![Pake](https://gw.alipayobjects.com/zos/k/zd/pake.gif) -**Pake provides a command line tool that makes it quicker and easier to customize the packages you need, as detailed in [documentation](./.github/workflows/docs/README_EN.md).** +**Pake provides a command line tool, making the flow of package customization quicker and easier. See [documentation](./bin/README_EN.md) for more information.** ```bash -// Install with npm +# Install with npm npm install -g pake-cli -// Command usage -pake url [options] +# Command usage +pake url [OPTIONS]... -// Play casually, first time due to the installation environment will be a little slow +# 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 --transparent ``` -If you are a little white who doesn't know how to use the command line, a good option is to use **GitHub Actions online compilation**, see the [tutorial](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version). +If you are new to the command line, you can compile packages online with _GitHub Actions_. See the [Tutorial](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version) for more information. ## Development -Before starting, make sure that the computer has installed the Rust `>=1.63` and Node `>=16 as 16.18.1` environment，refer to the [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites) to quickly configure your environment before you start. If you don't understand, it will be more appropriate to use the above command line to pack with one click. +Prepare your environment before starting. Make sure you have Rust `>=1.63` and Node `>=16` (e.g., `16.18.1`) installed on your computer. For installation guidance, see [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites). + +If you are unfamiliar with these, it is better to try out the above tool to pack with one click. ```sh -// Install Dependencies +# Install Dependencies npm i -// Local development +# Local development npm run dev -// Local debug +# Local debug npm run dev:debug -// Pack application +# Pack application npm run build - ``` -## Advanced use +## Advanced Usage -1. The code structure can be referred to [Here](https://github.com/tw93/Pake/wiki/Description-of-Pake's-code-structure), it is convenient for you to learn more before development. -2. Modify the `tauri.conf.json` and `tauri.xxx.conf.json` in the `src-tauri` directory to include 4 fields `url, productName, icon, identifier`, icon can be selected from the `icons` directory or downloaded from [macOSicons](https://macosicons.com/#/) to match the product. -3. For window property settings, you can modify the `width/height` of the `windows` property in `tauri.conf.json`, whether it is `fullscreen`, whether it is `resizable`, If you want to adapt the immersive header under Mac, you can set `transparent` to `true` and then find header element and add the `padding-top` style. -4. About style rewriting, advertising shielding, js injection, container message communication, and user-defined shortcut keys, you can see [Advanced Usage of Make](https://github.com/tw93/Pake/wiki/Advanced-Usage-of-Make). +1. You can refer to the [codebase structure](https://github.com/tw93/Pake/wiki/Description-of-Pake's-code-structure) before working on Pake, which will help you much in development. +2. Add four fields (`url`, `productName`, `icon`, and `identifier`) to the `tauri.conf.json` and `tauri.xxx.conf.json` in the `src-tauri` directory. You can select a `icon` from the `icons` directory or download one from [macOSicons](https://macosicons.com/#/) to match your product needs. +3. For configurations on window properties, you can modify the `tauri.conf.json` file to change the value of `width`, `height`, `fullscreen` (or not), `resizable` (or not) of the `windows` property. To adapt to the immersive header on Mac, change `transparent` to `true`, look for the `Header` element, and add the `padding-top` property. +4. For advanced usages such as style rewriting, advertisement removal, JS injection, container message communication, and user-defined shortcut keys, see [Advanced Usage of Make](https://github.com/tw93/Pake/wiki/Advanced-Usage-of-Make). ## Developer -Pake's development can not be separated from these Hackers, together contributed a lot of ability, also welcome to follow them ❤️ +Pake's development can not be without these Hackers. They contributed a lot of capabilities for Pake. Also, welcome to follow them! ❤️ @@ -304,7 +302,7 @@ Pake's development can not be separated from these Hackers, together contributed ## Support -1. I have two cats, one is called TangYuan, and one is called Coke, If you think Pake makes your life better, you can give my cats feed canned food 🥩🍤. -2. If you like Pake, you can star it in 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. -3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake, or join [Telegram](https://t.me/miaoyan) chat group. -4. I hope that you will enjoy playing with it. If you find a page that would be great for a Mac App, please let me know. +1. I have two cats, TangYuan and Coke. If you think Pake delights your life, you can feed my cats some canned food 🥩🍤. +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. +3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake or join our [Telegram](https://t.me/miaoyan) 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! diff --git a/bin/README_EN.md b/bin/README_EN.md index f8b3825..530e8bf 100644 --- a/bin/README_EN.md +++ b/bin/README_EN.md @@ -1,6 +1,6 @@ ## Install -Ensure your Node.js installation is greater than `16`, such as `16.8`. Do not use `sudo` to install. If `npm` reports that you don't have permission to install this, see [How to fix npm throwing error without sudo](https://stackoverflow.com/questions/16151018/how-to-fix-npm-throwing-error-without-sudo). +Ensure the version of your installed Node.js is greater than `16.0` such as `16.8`. Do not use `sudo` to install. If you encountered permission issues/problems while installing using npm, see [How to fix npm throwing error without sudo](https://stackoverflow.com/questions/16151018/how-to-fix-npm-throwing-error-without-sudo). ```bash npm install -g pake-cli @@ -64,7 +64,7 @@ The name of your application. We will prompt you to enter this if you do not pro #### [icon] -The application icon. Support local and remote files. By default, it is the brand icon of Pake. For customizing the icon of your product, go to [icon icons](https://icon-icons.com) or [macOSicons](https://macosicons.com/#/) to download it. +The application icon. Supports local and remote files. By default, it is the brand icon of Pake. For customizing the icon of your product, go to [icon icons](https://icon-icons.com) or [macOSicons](https://macosicons.com/#/) to download it. - macOS must be `.icns` - Windows must be `.ico`