diff --git a/README-zh-CN.md b/README-zh-CN.md index e151e59..85f4d88 100644 --- a/README-zh-CN.md +++ b/README-zh-CN.md @@ -1,37 +1,32 @@ # YukiHookAPI Project Builder -![Blank](https://img.shields.io/badge/license-AGPL3.0-blue) -![Blank](https://img.shields.io/badge/version-v1.0.4-green) -[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) -

- -
-
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE) +[![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/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + 帮助你快速创建一个使用 YukiHookAPI 打造的 Xposed 项目模板。 -
[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) 下载适合于你平台的应用程序。 -**以下是手动部署与编译步骤** +> 以下是手动部署与编译步骤 首先你需要安装 [node.js](https://nodejs.org/zh-cn/) -IDE 工具建议使用 **IntelliJ IDEA** 或 **WebStorm** - -不建议使用 **Visual Studio Code** 对代码进行格式化,可能会造成一些错误。 - - 执行如下命令安装 Electron ``` @@ -74,6 +69,16 @@ npm run make npm run package ``` +## 捐赠支持 + +工作不易,无意外情况此项目将继续维护下去,提供更多可能,欢迎打赏。 + +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) diff --git a/README.md b/README.md index 4cd99d8..bd4a6f9 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,50 @@ # YukiHookAPI Project Builder -![Blank](https://img.shields.io/badge/license-AGPL3.0-blue) -![Blank](https://img.shields.io/badge/version-v1.0.4-green) -[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) -

- -
-
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE) +[![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/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + A Xposed Project Builder by YukiHookAPI. -
English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md) ## 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 -- 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 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/) -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. -- Execute the following command to install Electron +Execute the following command to install Electron. ``` npm install --save-dev electron ``` -- Execute the following command to install yarn +Execute the following command to 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 @@ -55,13 +54,13 @@ npm install --save-dev @electron-forge/cli npx electron-forge import ``` -- Use the following command to debug +Use the following command to debug. ``` npm run start ``` -- Use the following commands to compile & package +Use the following commands to compile & package. **Linux/macOS** @@ -75,6 +74,10 @@ npm run make npm run package ``` +## Star History + +![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI-ProjectBuilder&type=Date) + ## License - [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)