Create README.md

README.md

@@ -0,0 +1,150 @@
+# YukiHookAPI Project Builder
+
+![Blank](https://img.shields.io/badge/license-AGPL3.0-blue)
+![Blank](https://img.shields.io/badge/version-v1.0.0-green)
+[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
+<br/><br/>
+<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png" width = "100" height = "100"/>
+<br/>
+<br/>
+A Xposed Project Builder by YukiHookAPI.
+<br/>
+
+## What's this
+
+- 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 an Xposed module environment
+
+**这是什么**
+
+- 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具
+
+- 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板
+
+## How to use
+
+- 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**
+
+First you need to install [node.js](https://nodejs.org/en/)
+
+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
+
+```
+npm install electron --save-dev
+```
+
+- Execute the following command to install yarn
+
+```
+npm install yarn
+```
+
+- Enter the project directory and execute the following command to install dependencies
+
+```
+npm install --production --registry=https://registry.npmmirror.com/
+```
+
+- Use the following command to debug
+
+```
+npm run start
+```
+
+- Use the following commands to compile & package
+
+**Linux/macOS**
+
+```
+npm run make
+```
+
+**Windows**
+
+```
+npm run package
+```
+
+**如何使用**
+
+- 本项目使用 **Electron** 开发，快速实现多平台本地化应用程序的构建和运行
+
+你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。
+
+**以下是手动部署与编译步骤**
+
+首先你需要安装 [node.js](https://nodejs.org/zh-cn/)
+
+IDE 工具建议使用 **IntelliJ IDEA** 或 **WebStorm**
+
+不建议使用 **Visual Studio Code** 对代码进行格式化，可能会造成一些错误。
+
+- 执行如下命令安装 Electron
+
+```
+npm install electron --save-dev
+```
+
+- 执行如下命令安装 yarn
+
+```
+npm install yarn
+```
+
+- 进入项目目录，执行如下命令安装依赖
+
+```
+npm install --production --registry=https://registry.npmmirror.com/
+```
+
+- 使用如下命令进行调试
+
+```
+npm run start
+```
+
+- 使用如下命令进行编译 & 打包
+
+**Linux/macOS**
+
+```
+npm run make
+```
+
+**Windows**
+
+```
+npm run package
+```
+
+## License
+
+- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)
+
+```
+Copyright (C) 2019-2022 HighCapable
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+```
+
+版权所有 © 2019-2022 HighCapable