HighCapable/YukiHookAPI-ProjectBuilder
5
0
Fork 0
mirror of https://github.com/HighCapable/YukiHookAPI-ProjectBuilder.git synced 2025-09-01 08:15:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update README, README-zh-CN

Browse Source
This commit is contained in:
fankesyooni
2023-09-21 05:05:58 +08:00
parent 38b2e48d1c
commit 8aefb7df64
2 changed files with 42 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README-zh-CN.md
View File

@@ -1,37 +1,32 @@
# YukiHookAPI Project Builder # YukiHookAPI Project Builder
![Blank](https://img.shields.io/badge/license-AGPL3.0-blue) [![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE)
![Blank](https://img.shields.io/badge/version-v1.0.4-green) [![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI-ProjectBuilder?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases)
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) [![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
<br/><br/> [![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev)
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100"/>
<br/> <img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100" alt="LOGO"/>
<br/>
帮助你快速创建一个使用 YukiHookAPI 打造的 Xposed 项目模板。 帮助你快速创建一个使用 YukiHookAPI 打造的 Xposed 项目模板。
<br/>
[English](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README.md) | 简体中文 [English](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README.md) | 简体中文
## 这是什么 ## 这是什么
- 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具。
- 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板。
## 如何使用 ## 如何使用
- 本项目使用 **Electron** 开发，快速实现多平台本地化应用程序的构建和运行 本项目使用 **Electron** 开发，快速实现多平台本地化应用程序的构建和运行。
你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。 你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。
**以下是手动部署与编译步骤** > 以下是手动部署与编译步骤
首先你需要安装 [node.js](https://nodejs.org/zh-cn/) 首先你需要安装 [node.js](https://nodejs.org/zh-cn/)
IDE 工具建议使用 **IntelliJ IDEA** 或 **WebStorm**
不建议使用 **Visual Studio Code** 对代码进行格式化，可能会造成一些错误。
- 执行如下命令安装 Electron - 执行如下命令安装 Electron
``` ```
@@ -74,6 +69,16 @@ npm run make
npm run package npm run package
``` ```
## 捐赠支持
工作不易，无意外情况此项目将继续维护下去，提供更多可能，欢迎打赏。
<img src="https://github.com/fankes/fankes/blob/main/img-src/payment_code.jpg?raw=true" width = "500" alt="Payment Code"/>
## Star History
![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI-ProjectBuilder&type=Date)
## 许可证 ## 许可证
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html) - [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)

39
README.md
View File

@@ -1,51 +1,50 @@
# YukiHookAPI Project Builder # YukiHookAPI Project Builder
![Blank](https://img.shields.io/badge/license-AGPL3.0-blue) [![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE)
![Blank](https://img.shields.io/badge/version-v1.0.4-green) [![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI-ProjectBuilder?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases)
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) [![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
<br/><br/> [![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev)
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100"/>
<br/> <img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100" alt="LOGO"/>
<br/>
A Xposed Project Builder by YukiHookAPI. A Xposed Project Builder by YukiHookAPI.
<br/>
English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md) English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md)
## What's this ## What's this
- This is an automatic building tool for Xposed modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core This is an automatic building tool for Xposed Modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core.
- Implementing automated search relies on quickly building an Android project template that includes a Xposed module environment Implementing automated search relies on quickly building an Android project template that includes a Xposed Module environment.
## How to use ## How to use
- This project is developed using **Electron** to quickly build and run multi-platform localized applications This project is developed using **Electron** to quickly build and run multi-platform localized applications.
You can download the application for your platform directly You can download the application for your platform directly
from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases). from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases).
**The following are the manual deployment and compilation steps** > The following are the manual deployment and compilation steps
First you need to install [node.js](https://nodejs.org/en/) First you need to install [node.js](https://nodejs.org/en/)
IDE tools recommend **IntelliJ IDEA** or **WebStorm** IDE tools recommend **IntelliJ IDEA** or **WebStorm**.
Formatting code with **Visual Studio Code** is not recommended and may cause some errors. Formatting code with **Visual Studio Code** is not recommended and may cause some errors.
- Execute the following command to install Electron Execute the following command to install Electron.
``` ```
npm install --save-dev electron npm install --save-dev electron
``` ```
- Execute the following command to install yarn Execute the following command to install yarn.
``` ```
npm install yarn npm install yarn
``` ```
- Enter the project directory and execute the following command to install dependencies Enter the project directory and execute the following command to install dependencies.
``` ```
npm install --save-dev @electron-forge/cli npm install --save-dev @electron-forge/cli
@@ -55,13 +54,13 @@ npm install --save-dev @electron-forge/cli
npx electron-forge import npx electron-forge import
``` ```
- Use the following command to debug Use the following command to debug.
``` ```
npm run start npm run start
``` ```
- Use the following commands to compile & package Use the following commands to compile & package.
**Linux/macOS** **Linux/macOS**
@@ -75,6 +74,10 @@ npm run make
npm run package npm run package
``` ```
## Star History
![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI-ProjectBuilder&type=Date)
## License ## License
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html) - [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)