Skip to content

Commit 2c5ab93

Browse files
committed
chore: update README
1 parent 032b660 commit 2c5ab93

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# EladmeGo
22

3+
![GitHub](https://img.shields.io/github/license/shensven/EladmeGo)
34
[![Test](https://github.com/shensven/EladmeGo/actions/workflows/test.yml/badge.svg?branch=dev)](https://github.com/shensven/EladmeGo/actions/workflows/test.yml)
45
[![CodeQL](https://github.com/shensven/EladmeGo/actions/workflows/codeql.yml/badge.svg?branch=dev)](https://github.com/shensven/EladmeGo/actions/workflows/codeql.yml)
56
[![Publish](https://github.com/shensven/EladmeGo/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/shensven/EladmeGo/actions/workflows/publish.yml)
67

7-
本项目是昆明金地中心访问通行的移动端轮子
8+
A mobile app for accessing the JindiCenter in Kunming
89

910
| 1 | 2 | 3 | 4 |
1011
| :---------------------------------------------: | :--------------------------------------------------: | :-----------------------------------------------------: | :-------------------------------------------------: |
1112
| ![Screenshot 1](src/assets/screenshot/home.png) | ![Screenshot 2](src/assets/screenshot/dark_mode.png) | ![Screenshot 3](src/assets/screenshot/floor_picker.png) | ![Screenshot 4](src/assets/screenshot/settings.png) |
1213

13-
## 📦 分发
14+
## 📦 Distribution
1415

1516
### iOS
1617

@@ -20,45 +21,49 @@
2021

2122
- [GitHub Releases](https://github.com/shensven/EladmeGo/releases)
2223

23-
## 🔨 编译
24+
## 🔨 Build
2425

25-
### 先决条件
26+
### Prequisites
2627

27-
- [Node 14](https://nodejs.org) 或更高版本
28-
- [yarn](https://yarnpkg.com/getting-started/install) 包管理器
28+
- [Node 14](https://nodejs.org) or higher
29+
- [yarn](https://yarnpkg.com/getting-started/install)
2930
- [Watchman](https://formulae.brew.sh/formula/watchman)
30-
- [Xcode 10](https://developer.apple.com/xcode/resources)或更高版本
31+
- [Xcode 10](https://developer.apple.com/xcode/resources) or higher
3132
- [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
32-
- [JDK 11](https://formulae.brew.sh/formula/openjdk@11) 或更高版本
33+
- [JDK 11](https://formulae.brew.sh/formula/openjdk@11) or higher
3334
- Android SDK
3435
- Build-Tools `33.0.0`
3536
- NDK `23.1.7779620`
3637

37-
### 起步
38+
### Get Started
3839

3940
```sh
4041
yarn install
4142
cd ios && pod install
4243
```
4344

44-
### iOS 真机部署
45+
### iOS Deployment
4546

4647
```sh
4748
yarn ios --configuration Release --device
4849
```
4950

50-
### 打包 Android apk
51+
### Assem the APK
5152

5253
```sh
5354
cd android && chmod +x gradlew
5455
./gradlew assembleRelease
5556
```
5657

57-
## 生成启动图
58+
### Generate the Splash Screen
5859

5960
```sh
6061
yarn react-native generate-bootsplash src/assets/splash/bootsplash.png \
6162
--background-color=F2E8E2 \
6263
--logo-width=288 \
6364
--flavor=main
6465
```
66+
67+
## ⚖️ License
68+
69+
EladmeGo is licensed under the [MIT license](./LICENSE).

0 commit comments

Comments
 (0)