Skip to content

Commit e8aed41

Browse files
nopdanWhiredPlanck
authored andcommitted
chore: optimize build doc
revert: remove communities in README
1 parent 2caa825 commit e8aed41

File tree

3 files changed

+43
-86
lines changed

3 files changed

+43
-86
lines changed

README.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,7 @@ Android SDK and Android NDK should be correctly installed and configured. If you
5858

5959
The needed version of JDK (OpenJDK) is 17 or 21.
6060

61-
### Build
62-
63-
<details>
64-
<summary><b>Prerequisites for Windows</b></summary>
61+
#### Prerequisites for Windows
6562

6663
Symbolic links will be created according to current build configurations, developers need:
6764

@@ -75,30 +72,26 @@ Symbolic links will be created according to current build configurations, develo
7572

7673
If you cannot or wouldn't like to enable anything, it doesn't matter. Copying will be used instead when error on creating symbolic links.
7774

78-
</details>
75+
### Build
7976

80-
1. Clone this project and fetch all submodules:
77+
#### 1. Clone this project and fetch all submodules:
8178

8279
```sh
8380
git clone [email protected]:osfans/trime.git
8481
git submodule update --init --recursive
8582
```
8683

87-
2. Debug version without signature:
84+
#### 2. Debug version without signature:
8885

89-
On Linux or macOS, you may run:
90-
91-
```bash
86+
```sh
87+
# On Linux or macOS
9288
make debug
93-
```
94-
95-
On Windows, run:
9689

97-
```powershell
90+
# On Windows
9891
.\gradlew assembleDebug
9992
```
10093

101-
3. Release version with signture:
94+
#### 3. Release version with signture:
10295

10396
Create `keystore.properties` file which contains following contents for [signing information](https://developer.android.com/studio/publish/app-signing.html):
10497

@@ -109,15 +102,13 @@ keyAlias=myKeyAlias
109102
storeFile=myStoreFileLocation
110103
```
111104

112-
Then, on Linux or macOS, you may run:
105+
Then, you may run:
113106

114-
```bash
107+
```sh
108+
# On Linux or macOS
115109
make release
116-
```
117-
118-
On Windows, run:
119110

120-
```powershell
111+
# On Windows
121112
.\gradlew assembleRelease
122113
```
123114

@@ -145,7 +136,7 @@ Other issues:
145136
- Translators: 天真可爱的满满 (Chinese Traditional), 点解 (English) ...
146137
- Keyboard Designers: 天真可爱的满满、皛筱晓小笨鱼、吴琛 11、熊猫阿 Bo、默默ㄇㄛ ˋ...
147138
- Donations: See QR Code in [Releases](https://github.com/osfans/trime/releases)
148-
- Community: Netizens who feedback in [Community](#Community)
139+
- Community: Netizens who feedback in [Issues](https://github.com/osfans/trime/issues)[QQ Group (811142286)](https://jq.qq.com/?_wv=1027&k=AXdR80HN)[QQ Group (224230445)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=pg_q7UVumWYLq1Rk8kIAqkK1xGt64VnX&authKey=04m9l7OBO5H5vgrEL8IbpsmtnptWM60xy%2FUwYCfyvw9VcRhe8zRzAS1ezoemZdFr&noverify=0&group_code=224230445)[Tieba](http://tieba.baidu.com/f?kw=rime)[Google Play](https://play.google.com/store/apps/details?id=com.osfans.trime)[Telegram](https://t.me/trime_dev)...
149140
- Projects: [RIME][OpenCC][Android Traditional Chinese IME] and so on.
150141

151142
## Third Party Libraries

README_sc.md

Lines changed: 15 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,6 @@
2626

2727
- 配置文档 [rimerc](https://github.com/Bambooin/rimerc)
2828

29-
## 社区
30-
31-
- [Issues](https://github.com/osfans/trime/issues)
32-
- [QQ 群 (811142286)](https://jq.qq.com/?_wv=1027&k=AXdR80HN)
33-
- [QQ 群 (224230445)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=pg_q7UVumWYLq1Rk8kIAqkK1xGt64VnX&authKey=04m9l7OBO5H5vgrEL8IbpsmtnptWM60xy%2FUwYCfyvw9VcRhe8zRzAS1ezoemZdFr&noverify=0&group_code=224230445)
34-
- [贴吧](http://tieba.baidu.com/f?kw=rime)
35-
- [Telegram](https://t.me/trime_dev)
36-
3729
## 沿革
3830

3931
TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写:
@@ -53,10 +45,7 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写:
5345

5446
对 JDK(OpenJDK)版本的要求是 17 或 21。
5547

56-
### 构建
57-
58-
<details>
59-
<summary><b>Windows 上的前提条件</b></summary>
48+
#### Windows 上的前提条件
6049

6150
当前构建配置会使构建过程中创建符号链接,开发者需要:
6251

@@ -70,30 +59,26 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写:
7059

7160
如果无法或者不想启用上述设置也没关系。构建系统会自动在符号链接创建失败时使用复制代替。
7261

73-
</details>
62+
### 构建
7463

75-
1. 克隆此项目并拉取所有子模块。
64+
#### 1. 克隆此项目并拉取所有子模块。
7665

7766
```sh
7867
git clone [email protected]:osfans/trime.git
7968
git submodule update --init --recursive
8069
```
8170

82-
2. 编译调试版本:
83-
84-
Linux 或 macOS 上可执行:
71+
#### 2. 编译调试版本:
8572

86-
```bash
73+
```sh
74+
# On Linux or macOS
8775
make debug
88-
```
89-
90-
Windows 上执行:
9176

92-
```powershell
93-
.\gradle :app:assembleDebug
77+
# On Windows
78+
.\gradlew assembleDebug
9479
```
9580

96-
3. 编译正式版本:
81+
#### 3. 编译正式版本:
9782

9883
请创建 `keystore.properties` 文件,包含以下内容,注明[签名信息](https://developer.android.com/studio/publish/app-signing.html)
9984

@@ -104,16 +89,14 @@ keyAlias=myKeyAlias
10489
storeFile=myStoreFileLocation
10590
```
10691

107-
之后,Linux 和 macOS 上可执行
92+
然后执行
10893

109-
```bash
94+
```sh
95+
# On Linux or macOS
11096
make release
111-
```
112-
113-
Windows 上执行:
11497

115-
```powershell
116-
.\gradlew :app:assembleRelease
98+
# On Windows
99+
.\gradlew assembleRelease
117100
```
118101

119102
### 故障排除
@@ -140,7 +123,7 @@ Target "boost_log_setup" links to target "Boost::coroutine" but the target was n
140123
- 翻译:天真可爱的满满(繁体中文)、点解(英文)......
141124
- 键盘:天真可爱的满满、皛筱晓小笨鱼、吴琛 11、熊猫阿 Bo、默默ㄇㄛ ˋ......
142125
- 捐赠:[Releases](https://github.com/osfans/trime/releases) 中的“打赏”实时更新
143-
- 社区:在[社区](#社区)中反馈意见的网友
126+
- 社区:在 [Issues](https://github.com/osfans/trime/issues)[QQ 群 (811142286)](https://jq.qq.com/?_wv=1027&k=AXdR80HN)[QQ 群 (224230445)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=pg_q7UVumWYLq1Rk8kIAqkK1xGt64VnX&authKey=04m9l7OBO5H5vgrEL8IbpsmtnptWM60xy%2FUwYCfyvw9VcRhe8zRzAS1ezoemZdFr&noverify=0&group_code=224230445)[Google Play](https://play.google.com/store/apps/details?id=com.osfans.trime)[贴吧](http://tieba.baidu.com/f?kw=rime)[Telegram](https://t.me/trime_dev) 中反馈意见的网友
144127
- 项目:[RIME][OpenCC][注音仓颉输入法]等开源项目
145128

146129
## 第三方库

README_tc.md

Lines changed: 15 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,6 @@
2626

2727
- 配置文件 [rimerc](https://github.com/Bambooin/rimerc)
2828

29-
## 社區
30-
31-
- [Issues](https://github.com/osfans/trime/issues)
32-
- [QQ 群 (811142286)](https://jq.qq.com/?_wv=1027&k=AXdR80HN)
33-
- [QQ 群 (224230445)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=pg_q7UVumWYLq1Rk8kIAqkK1xGt64VnX&authKey=04m9l7OBO5H5vgrEL8IbpsmtnptWM60xy%2FUwYCfyvw9VcRhe8zRzAS1ezoemZdFr&noverify=0&group_code=224230445)
34-
- [贴吧](http://tieba.baidu.com/f?kw=rime)
35-
- [Telegram](https://t.me/trime_dev)
36-
3729
## 沿革
3830

3931
TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫:
@@ -53,10 +45,7 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫:
5345

5446
對 JDK(OpenJDK)版本的要求是 17 或 21。
5547

56-
### 構建
57-
58-
<details>
59-
<summary><b>Windows 上的前提條件</b></summary>
48+
#### Windows 上的前提條件
6049

6150
當前構建配置會使構建過程中建立符號連結,開發者需要:
6251

@@ -70,30 +59,26 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫:
7059

7160
如果無法或者不想啟用上述設定也沒關係。構建系統會自動在符號連結建立失敗時使用複製代替。
7261

73-
</details>
62+
### 構建
7463

75-
1. 克隆此專案並拉取所有子模組。
64+
#### 1. 克隆此專案並拉取所有子模組。
7665

7766
```sh
7867
git clone [email protected]:osfans/trime.git
7968
git submodule update --init --recursive
8069
```
8170

82-
2. 編譯除錯版本:
83-
84-
Linux 或 macOS 上可執行:
71+
#### 2. 編譯除錯版本:
8572

86-
```bash
73+
```sh
74+
# On Linux or macOS
8775
make debug
88-
```
89-
90-
Windows 上執行:
9176

92-
```powershell
93-
.\gradle :app:assembleDebug
77+
# On Windows
78+
.\gradlew assembleDebug
9479
```
9580

96-
3. 編譯正式版本:
81+
#### 3. 編譯正式版本:
9782

9883
請建立 `keystore.properties` 檔案,包含以下內容,註明[簽名信息](https://developer.android.com/studio/publish/app-signing.html)
9984

@@ -104,16 +89,14 @@ keyAlias=myKeyAlias
10489
storeFile=myStoreFileLocation
10590
```
10691

107-
之後,Linux 或 macOS 上可執行
92+
然後執行
10893

109-
```bash
94+
```sh
95+
# On Linux or macOS
11096
make release
111-
```
112-
113-
Windows 上執行:
11497

115-
```powershell
116-
.\gradlew :app:assembleRelease
98+
# On Windows
99+
.\gradlew assembleRelease
117100
```
118101

119102
### 故障排除
@@ -140,7 +123,7 @@ Target "boost_log_setup" links to target "Boost::coroutine" but the target was n
140123
- 翻譯:天真可愛的滿滿(繁體中文)、點解(英文)......
141124
- 鍵盤:天真可愛的滿滿、皛筱曉小笨魚、吳琛 11、熊貓阿 Bo、默默ㄇㄛ ˋ......
142125
- 捐贈:[Releases](https://github.com/osfans/trime/releases) 中的“打賞”實時更新
143-
- 社群:在 [社區](#社區)中反饋意見的網友
126+
- 社群:在 [Issues](https://github.com/osfans/trime/issues)[QQ 群 (811142286)](https://jq.qq.com/?_wv=1027&k=AXdR80HN)[QQ 群 (224230445)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=pg_q7UVumWYLq1Rk8kIAqkK1xGt64VnX&authKey=04m9l7OBO5H5vgrEL8IbpsmtnptWM60xy%2FUwYCfyvw9VcRhe8zRzAS1ezoemZdFr&noverify=0&group_code=224230445)[貼吧](http://tieba.baidu.com/f?kw=rime)[Google Play](https://play.google.com/store/apps/details?id=com.osfans.trime)[Telegram](https://t.me/trime_dev) 中反饋意見的網友
144127
- 專案:[RIME][OpenCC][注音倉頡輸入法]等開源專案
145128

146129
## 第三方庫

0 commit comments

Comments
 (0)