From e8aed41b528baaf7412bd1cb66faa9b557dcf527 Mon Sep 17 00:00:00 2001 From: nopdan Date: Wed, 7 Feb 2024 15:02:56 +0800 Subject: [PATCH] chore: optimize build doc revert: remove communities in README --- README.md | 35 +++++++++++++---------------------- README_sc.md | 47 +++++++++++++++-------------------------------- README_tc.md | 47 +++++++++++++++-------------------------------- 3 files changed, 43 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index e27319ec3e..e372feb196 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,7 @@ Android SDK and Android NDK should be correctly installed and configured. If you The needed version of JDK (OpenJDK) is 17 or 21. -### Build - -
-Prerequisites for Windows +#### Prerequisites for Windows Symbolic links will be created according to current build configurations, developers need: @@ -75,30 +72,26 @@ Symbolic links will be created according to current build configurations, develo 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. -
+### Build -1. Clone this project and fetch all submodules: +#### 1. Clone this project and fetch all submodules: ```sh git clone git@github.com:osfans/trime.git git submodule update --init --recursive ``` -2. Debug version without signature: +#### 2. Debug version without signature: -On Linux or macOS, you may run: - -```bash +```sh +# On Linux or macOS make debug -``` - -On Windows, run: -```powershell +# On Windows .\gradlew assembleDebug ``` -3. Release version with signture: +#### 3. Release version with signture: Create `keystore.properties` file which contains following contents for [signing information](https://developer.android.com/studio/publish/app-signing.html): @@ -109,15 +102,13 @@ keyAlias=myKeyAlias storeFile=myStoreFileLocation ``` -Then, on Linux or macOS, you may run: +Then, you may run: -```bash +```sh +# On Linux or macOS make release -``` - -On Windows, run: -```powershell +# On Windows .\gradlew assembleRelease ``` @@ -145,7 +136,7 @@ Other issues: - Translators: 天真可爱的满满 (Chinese Traditional), 点解 (English) ... - Keyboard Designers: 天真可爱的满满、皛筱晓小笨鱼、吴琛 11、熊猫阿 Bo、默默ㄇㄛ ˋ... - Donations: See QR Code in [Releases](https://github.com/osfans/trime/releases) -- Community: Netizens who feedback in [Community](#Community) +- 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)... - Projects: [RIME]、[OpenCC]、[Android Traditional Chinese IME] and so on. ## Third Party Libraries diff --git a/README_sc.md b/README_sc.md index 2c549f4d45..0f8da266c9 100644 --- a/README_sc.md +++ b/README_sc.md @@ -26,14 +26,6 @@ - 配置文档 [rimerc](https://github.com/Bambooin/rimerc) -## 社区 - -- [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) -- [Telegram](https://t.me/trime_dev) - ## 沿革 TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写: @@ -53,10 +45,7 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写: 对 JDK（OpenJDK）版本的要求是 17 或 21。 -### 构建 - -
-Windows 上的前提条件 +#### Windows 上的前提条件 当前构建配置会使构建过程中创建符号链接，开发者需要： @@ -70,30 +59,26 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写: 如果无法或者不想启用上述设置也没关系。构建系统会自动在符号链接创建失败时使用复制代替。 -
+### 构建 -1. 克隆此项目并拉取所有子模块。 +#### 1. 克隆此项目并拉取所有子模块。 ```sh git clone git@github.com:osfans/trime.git git submodule update --init --recursive ``` -2. 编译调试版本: - -Linux 或 macOS 上可执行： +#### 2. 编译调试版本: -```bash +```sh +# On Linux or macOS make debug -``` - -Windows 上执行： -```powershell -.\gradle :app:assembleDebug +# On Windows +.\gradlew assembleDebug ``` -3. 编译正式版本： +#### 3. 编译正式版本： 请创建 `keystore.properties` 文件，包含以下内容，注明[签名信息](https://developer.android.com/studio/publish/app-signing.html)： @@ -104,16 +89,14 @@ keyAlias=myKeyAlias storeFile=myStoreFileLocation ``` -之后，Linux 和 macOS 上可执行： +然后执行： -```bash +```sh +# On Linux or macOS make release -``` - -Windows 上执行： -```powershell -.\gradlew :app:assembleRelease +# On Windows +.\gradlew assembleRelease ``` ### 故障排除 @@ -140,7 +123,7 @@ Target "boost_log_setup" links to target "Boost::coroutine" but the target was n - 翻译：天真可爱的满满（繁体中文）、点解（英文）...... - 键盘：天真可爱的满满、皛筱晓小笨鱼、吴琛 11、熊猫阿 Bo、默默ㄇㄛ ˋ...... - 捐赠：[Releases](https://github.com/osfans/trime/releases) 中的“打赏”实时更新 -- 社区：在[社区](#社区)中反馈意见的网友 +- 社区：在 [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) 中反馈意见的网友 - 项目：[RIME]、[OpenCC]、[注音仓颉输入法]等开源项目 ## 第三方库 diff --git a/README_tc.md b/README_tc.md index c9520d0876..9980679bc7 100644 --- a/README_tc.md +++ b/README_tc.md @@ -26,14 +26,6 @@ - 配置文件 [rimerc](https://github.com/Bambooin/rimerc) -## 社區 - -- [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) -- [Telegram](https://t.me/trime_dev) - ## 沿革 TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫: @@ -53,10 +45,7 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫: 對 JDK（OpenJDK）版本的要求是 17 或 21。 -### 構建 - -
-Windows 上的前提條件 +#### Windows 上的前提條件 當前構建配置會使構建過程中建立符號連結，開發者需要： @@ -70,30 +59,26 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫: 如果無法或者不想啟用上述設定也沒關係。構建系統會自動在符號連結建立失敗時使用複製代替。 -
+### 構建 -1. 克隆此專案並拉取所有子模組。 +#### 1. 克隆此專案並拉取所有子模組。 ```sh git clone git@github.com:osfans/trime.git git submodule update --init --recursive ``` -2. 編譯除錯版本: - -Linux 或 macOS 上可執行： +#### 2. 編譯除錯版本: -```bash +```sh +# On Linux or macOS make debug -``` - -Windows 上執行： -```powershell -.\gradle :app:assembleDebug +# On Windows +.\gradlew assembleDebug ``` -3. 編譯正式版本： +#### 3. 編譯正式版本： 請建立 `keystore.properties` 檔案，包含以下內容，註明[簽名信息](https://developer.android.com/studio/publish/app-signing.html)： @@ -104,16 +89,14 @@ keyAlias=myKeyAlias storeFile=myStoreFileLocation ``` -之後，Linux 或 macOS 上可執行： +然後執行： -```bash +```sh +# On Linux or macOS make release -``` - -Windows 上執行： -```powershell -.\gradlew :app:assembleRelease +# On Windows +.\gradlew assembleRelease ``` ### 故障排除 @@ -140,7 +123,7 @@ Target "boost_log_setup" links to target "Boost::coroutine" but the target was n - 翻譯：天真可愛的滿滿（繁體中文）、點解（英文）...... - 鍵盤：天真可愛的滿滿、皛筱曉小笨魚、吳琛 11、熊貓阿 Bo、默默ㄇㄛ ˋ...... - 捐贈：[Releases](https://github.com/osfans/trime/releases) 中的“打賞”實時更新 -- 社群：在 [社區](#社區)中反饋意見的網友 +- 社群：在 [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) 中反饋意見的網友 - 專案：[RIME]、[OpenCC]、[注音倉頡輸入法]等開源專案 ## 第三方庫