Skip to content

Commit 559fc85

Browse files
committed
Added readme document language isolation
1 parent f8ee164 commit 559fc85

File tree

2 files changed

+104
-65
lines changed

2 files changed

+104
-65
lines changed

README-zh-CN.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# YukiHookAPI Project Builder
2+
3+
![Blank](https://img.shields.io/badge/license-AGPL3.0-blue)
4+
![Blank](https://img.shields.io/badge/version-v1.0.0-green)
5+
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
6+
<br/><br/>
7+
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png" width = "100" height = "100"/>
8+
<br/>
9+
<br/>
10+
帮助你快速创建一个使用 YukiHookAPI 打造的 Xposed 项目模板。
11+
<br/>
12+
13+
[English](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README.md) | 简体中文
14+
15+
## 这是什么
16+
17+
- 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具
18+
19+
- 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板
20+
21+
## 如何使用
22+
23+
- 本项目使用 **Electron** 开发,快速实现多平台本地化应用程序的构建和运行
24+
25+
你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。
26+
27+
**以下是手动部署与编译步骤**
28+
29+
首先你需要安装 [node.js](https://nodejs.org/zh-cn/)
30+
31+
IDE 工具建议使用 **IntelliJ IDEA****WebStorm**
32+
33+
不建议使用 **Visual Studio Code** 对代码进行格式化,可能会造成一些错误。
34+
35+
- 执行如下命令安装 Electron
36+
37+
```
38+
npm install --save-dev electron
39+
```
40+
41+
- 执行如下命令安装 yarn
42+
43+
```
44+
npm install yarn
45+
```
46+
47+
- 进入项目目录,执行如下命令安装依赖
48+
49+
```
50+
npm install --save-dev @electron-forge/cli
51+
```
52+
53+
```
54+
npx electron-forge import
55+
```
56+
57+
- 使用如下命令进行调试
58+
59+
```
60+
npm run start
61+
```
62+
63+
- 使用如下命令进行编译 & 打包
64+
65+
**Linux/macOS**
66+
67+
```
68+
npm run make
69+
```
70+
71+
**Windows**
72+
73+
```
74+
npm run package
75+
```
76+
77+
## 许可证
78+
79+
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)
80+
81+
```
82+
Copyright (C) 2019-2022 HighCapable
83+
84+
This program is free software: you can redistribute it and/or modify
85+
it under the terms of the GNU Affero General Public License as
86+
published by the Free Software Foundation, either version 3 of the
87+
License, or (at your option) any later version.
88+
89+
This program is distributed in the hope that it will be useful,
90+
but WITHOUT ANY WARRANTY; without even the implied warranty of
91+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92+
GNU Affero General Public License for more details.
93+
94+
You should have received a copy of the GNU Affero General Public License
95+
along with this program. If not, see <http://www.gnu.org/licenses/>.
96+
```
97+
98+
版权所有 © 2019-2022 HighCapable

README.md

Lines changed: 6 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,20 @@
1010
A Xposed Project Builder by YukiHookAPI.
1111
<br/>
1212

13+
English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md)
14+
1315
## What's this
1416

1517
- This is an automatic building tool for Xposed modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core
1618

17-
- Implementing automated search relies on quickly building an Android project template that includes an Xposed module environment
18-
19-
**这是什么**
20-
21-
- 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具
22-
23-
- 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板
19+
- Implementing automated search relies on quickly building an Android project template that includes a Xposed module environment
2420

2521
## How to use
2622

2723
- This project is developed using **Electron** to quickly build and run multi-platform localized applications
2824

29-
You can download the application for your platform directly from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases).
25+
You can download the application for your platform directly
26+
from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases).
3027

3128
**The following are the manual deployment and compilation steps**
3229

@@ -78,62 +75,6 @@ npm run make
7875
npm run package
7976
```
8077

81-
**如何使用**
82-
83-
- 本项目使用 **Electron** 开发,快速实现多平台本地化应用程序的构建和运行
84-
85-
你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。
86-
87-
**以下是手动部署与编译步骤**
88-
89-
首先你需要安装 [node.js](https://nodejs.org/zh-cn/)
90-
91-
IDE 工具建议使用 **IntelliJ IDEA****WebStorm**
92-
93-
不建议使用 **Visual Studio Code** 对代码进行格式化,可能会造成一些错误。
94-
95-
- 执行如下命令安装 Electron
96-
97-
```
98-
npm install --save-dev electron
99-
```
100-
101-
- 执行如下命令安装 yarn
102-
103-
```
104-
npm install yarn
105-
```
106-
107-
- 进入项目目录,执行如下命令安装依赖
108-
109-
```
110-
npm install --save-dev @electron-forge/cli
111-
```
112-
113-
```
114-
npx electron-forge import
115-
```
116-
117-
- 使用如下命令进行调试
118-
119-
```
120-
npm run start
121-
```
122-
123-
- 使用如下命令进行编译 & 打包
124-
125-
**Linux/macOS**
126-
127-
```
128-
npm run make
129-
```
130-
131-
**Windows**
132-
133-
```
134-
npm run package
135-
```
136-
13778
## License
13879

13980
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)
@@ -155,4 +96,4 @@ You should have received a copy of the GNU Affero General Public License
15596
along with this program. If not, see <http://www.gnu.org/licenses/>.
15697
```
15798

158-
版权所有 © 2019-2022 HighCapable
99+
Copyright © 2019-2022 HighCapable

0 commit comments

Comments
 (0)