chore: update build guides

README.md

@@ -47,49 +47,81 @@ Benefit from the [librime](https://github.com/rime/librime) project by JNI, we a
 
 Your [contribution](CONTRIBUTING.md) are welcome ~ ! :tada:
 
-## Getting Started
+## Getting Started for developer
 
 ### Prepare
 
 Android SDK should be correctly installed and configured. If you are new to Android development, please install Android Studio.
 
 ### Build
 
-1. Clone this project, please **pay attention** that it would take a while for large-size `boost` submodule. And make sure that you have enough available disk space to hold the source code (about 1.5 GB).
+<details>
+<summary>Prerequisites for Windows</summary>
 
-```bash
-cd $your_folder
-git clone --recursive https://github.com/osfans/trime.git
+Symbolic links will be created according to current build configurations, developers need:
+
+- Enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) so that symlinks can be created without administrator privilege.
+
+- Enable symlink support for `git`:
+
+    ```powershell
+    git config --global core.symlinks true
+    ```
+
+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.
+
+</details>
+
+1. Clone this project and fetch all submodules:
+
+```sh
+git clone --recursive git@github.com:osfans/trime.git
 ```
 
-2. Debug version without sign:
+2. Debug version without signature:
+
+On Linux or macOS, you may run:
 
 ```bash
 make debug
 ```
 
-3. Release version with sign:
+On Windows, run:
+
+```powershell
+.\gradlew assembleDebug
+```
+
+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):
 
-```bash
+```gradle.properties
 storePassword=myStorePassword
 keyPassword=mykeyPassword
 keyAlias=myKeyAlias
 storeFile=myStoreFileLocation
 ```
 
+Then, on Linux or macOS, you may run:
+
 ```bash
 make release
 ```
 
+On Windows, run:
+
+```powershell
+.\gradlew assembleRelease
+```
+
 ### Troubleshooting
 
 ```
 Target "boost_log_setup" links to target "Boost::coroutine" but the target was not found.
 ```
 
-Run `make clean`.
+Run `make clean` on Linux or macOS, or run `.\gradlew assembleRelease` on Windows.
 
 Other issues:
 1. Try `make clean`

README_sc.md

@@ -41,49 +41,81 @@ TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的缩写:
 
 现在欢迎你前来[贡献](CONTRIBUTING.md) ～！:tada:
 
-## 入门
+## 开发入门
 
 ### 准备
 
-Android SDK 应该已经被安装并且正确配置。如果你还不熟悉 Android 开发，建议安装 Android Studio，它会自动安装并配置 Android 开发环境。
+开发者应正确安装配置好 Android SDK 和 Android NDK。如果还不熟悉 Android 开发，建议安装 Android Studio，它会自动安装并配置 Android 开发环境。
 
 ### 构建
 
-1. 克隆此项目，请注意由于 `boost` 子模块很大，这会花费一些时间。同时，请确保你的磁盘有足够空间保存源代码（约 1.5 GB);
+<details>
+<summary>Windows 上的前提条件</summary>
 
-```bash
-cd $your_folder
-git clone --recursive https://github.com/osfans/trime.git
+当前构建配置会使构建过程中创建符号链接，开发者需要：
+
+- 启用[开发者模式](https://learn.microsoft.com/zh-cn/windows/apps/get-started/enable-your-device-for-development) 以在无管理员权限的情况下创建符号链接。
+
+- 启用 `git` 的符号链接支持：
+
+    ```powershell
+    git config --global core.symlinks true
+    ```
+
+如果无法或者不想启用上述设置也没关系。构建系统会自动在符号链接创建失败时使用复制代替。
+
+</details>
+
+1. 克隆此项目并拉取所有子模块。
+
+```sh
+git clone git@github.com:osfans/trime.git
+git submodule update --init --recursive
 ```
 
 2. 编译调试版本:
 
+Linux 或 macOS 上可执行：
+
 ```bash
 make debug
 ```
 
+Windows 上执行：
+
+```powershell
+.\gradle :app:assembleDebug
+```
+
 3. 编译正式版本：
 
-请创建一个名为 `keystore.properties` 的文件，包含以下内容，注明[签名信息](https://developer.android.com/studio/publish/app-signing.html):
+请创建 `keystore.properties` 文件，包含以下内容，注明[签名信息](https://developer.android.com/studio/publish/app-signing.html)：
 
-```bash
+```gradle.properties
 storePassword=myStorePassword
 keyPassword=mykeyPassword
 keyAlias=myKeyAlias
 storeFile=myStoreFileLocation
 ```
 
+之后，Linux 和 macOS 上可执行：
+
 ```bash
 make release
 ```
 
+Windows 上执行：
+
+```powershell
+.\gradlew :app:assembleRelease
+```
+
 ### 故障排除
 
 ```
 Target "boost_log_setup" links to target "Boost::coroutine" but the target was not found.
 ```
-
-执行 `make clean`.
+在 Linux 或 macOS 上执行 `make clean`，Windows 上执行 `.\gradlew clean`。
 
 其他问题:
 1. 首先尝试 `make clean`

README_tc.md

@@ -15,9 +15,9 @@
 - 穩定版 <br>
 [<img alt='Get it on F-Droid' src='https://fdroid.gitlab.io/artwork/badge/get-it-on.png' height='80px'/>](https://f-droid.org/packages/com.osfans.trime)
 [<img alt='Google Play 立即下載' src='https://play.google.com/intl/en_us/badges/images/generic/zh-tw_badge_web_generic.png' height='80px'/>](https://play.google.com/store/apps/details?id=com.osfans.trime)
-[<img alt='酷安' src='https://static.coolapk.com/static/web/v8/img/icon.png' height='80px'/>](https://www.coolapk.com/apk/com.osfans.trime)
+[<img alt='酷安' src='https://static.coolapk.com/static/web/v8/img/icon.png' height='60px'/>](https://www.coolapk.com/apk/com.osfans.trime)
 
-- 測試版 [點擊下載](https://github.com/osfans/trime/actions)
+- 測試版 [點選下載](https://github.com/osfans/trime/actions)
 
 - 配置文件 [rimerc](https://github.com/Bambooin/rimerc)
 
@@ -26,67 +26,100 @@
 - 貢獻：[boboIqiqi](https://github.com/boboIqiqi)、[Bambooin](https://github.com/Bambooin)、[senchi96](https://github.com/senchi96)、[heiher](https://github.com/heiher)、[abay](https://github.com/a342191555)、[iovxw](https://github.com/iovxw)、[huyz-git](https://github.com/huyz-git)、[tumuyan](https://github.com/tumuyan)、[WhiredPlanck](https://github.com/WhiredPlanck)......
 - [維基](https://github.com/osfans/trime/wiki)：[xiaoqun2016](https://github.com/xiaoqun2016)、[boboIqiqi](https://github.com/boboIqiqi)......
 - 翻譯：天真可愛的滿滿（繁體中文）、點解（英文）......
-- 鍵盤：天真可愛的滿滿、皛筱晓小笨鱼、吴琛11、熊貓阿Bo、默默ㄇㄛˋ......
+- 鍵盤：天真可愛的滿滿、皛筱曉小笨魚、吳琛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 羣（458845988）](https://jq.qq.com/?_wv=1027&k=n6xT4G3q)、[酷安](http://www.coolapk.com/apk/com.osfans.trime)、[Google Play](https://play.google.com/store/apps/details?id=com.osfans.trime) 和[貼吧](http://tieba.baidu.com/f?kw=rime)中反饋意見的網友
-- 項目：[RIME]、[OpenCC]、[注音倉頡輸入法]等開源項目
+- 社群：在 [Issues](https://github.com/osfans/trime/issues)、[QQ 群（811142286）](https://jq.qq.com/?_wv=1027&k=AXdR80HN)、[QQ 群（458845988）](https://jq.qq.com/?_wv=1027&k=n6xT4G3q)、[酷安](http://www.coolapk.com/apk/com.osfans.trime)、[Google Play](https://play.google.com/store/apps/details?id=com.osfans.trime) 和[貼吧](http://tieba.baidu.com/f?kw=rime)中反饋意見的網友
+- 專案：[RIME]、[OpenCC]、[注音倉頡輸入法]等開源專案
 
 ## 沿革
-TRIME 是 Tongwen RIME 或是 ThaeRvInputMethod 的縮寫:
-- 最初，輸入法是寫給[泰如拼音](http://taerv.nguyoeh.com/ime/)（tae5 rv2）的，中文名爲“泰如輸入法”;
-- 然後，添加了吳語等方言碼表，做成了一個輸入法平臺，更名爲“漢字方言輸入法”;
-- 後來，兼容了五筆、兩筆等形碼，在太空衛士、徵羽的建議下，更名爲“[同文輸入法平臺 2.x](https://github.com/osfans/trime-legacy)”。寓意音碼形碼同臺，方言官話同文。
-- 之後，藉助 JNI 技術，享受了 [librime](https://github.com/rime/librime) 的成果，升級爲“同文輸入法平臺 3.x”，簡稱“同文輸入法”。
+TRIME 是 Tongwen RIME 或是 ThaeRvInputMEthod 的縮寫:
+
+- 最初，輸入法是寫給[泰如拼音](http://taerv.nguyoeh.com/ime/)（tae5 rv2）的，中文名為“泰如輸入法”;
+- 然後，添加了吳語等方言碼錶，做成了一個輸入法平臺，更名為“漢字方言輸入法”;
+- 後來，相容了五筆、兩筆等形碼，在太空衛士、徵羽的建議下，更名為“[同文輸入法平臺 2.x](https://github.com/osfans/trime-legacy)”。寓意音碼形碼同臺，方言官話同文。
+- 之後，藉助 JNI 技術，享受了 [librime](https://github.com/rime/librime) 的成果，升級為“同文輸入法平臺 3.x”，簡稱“同文輸入法”。
 
 現在歡迎你前來[貢獻](CONTRIBUTING.md) ～！:tada:
 
-## 入門
+## 開發入門
 
 ### 準備
 
-Android SDK 應該已經被安裝並且正確配置。如果你還不熟悉 Android 開發，建議安裝 Android Studio，它會自動安裝並配置 Android 開發環境。
+開發者應正確安裝配置好 Android SDK 和 Android NDK。如果還不熟悉 Android 開發，建議安裝 Android Studio，它會自動安裝並配置 Android 開發環境。
 
 ### 構建
 
-1. 克隆此項目，請注意由於 `boost` 子模塊很大，這會花費一些時間。同時，請確保你的磁盤有足夠空間保存源代碼（約 1.5 GB);
+<details>
+<summary>Windows 上的前提條件</summary>
 
-```bash
-cd $your_folder
-git clone --recursive https://github.com/osfans/trime.git
+當前構建配置會使構建過程中建立符號連結，開發者需要：
+
+- 啟用[開發者模式](https://learn.microsoft.com/zh-cn/windows/apps/get-started/enable-your-device-for-development) 以在無管理員許可權的情況下建立符號連結。
+
+- 啟用 `git` 的符號連結支援：
+
+    ```powershell
+    git config --global core.symlinks true
+    ```
+
+如果無法或者不想啟用上述設定也沒關係。構建系統會自動在符號連結建立失敗時使用複製代替。
+
+</details>
+
+1. 克隆此專案並拉取所有子模組。
+
+```sh
+git clone git@github.com:osfans/trime.git
+git submodule update --init --recursive
 ```
 
-2. 編譯調試版本:
+2. 編譯除錯版本:
+
+Linux 或 macOS 上可執行：
 
 ```bash
 make debug
 ```
 
+Windows 上執行：
+
+```powershell
+.\gradle :app:assembleDebug
+```
+
 3. 編譯正式版本：
 
-請創建一個名為 keystore.properties 的文件，包含以下內容，註明[簽名信息](https://developer.android.com/studio/publish/app-signing.html):
+請建立 `keystore.properties` 檔案，包含以下內容，註明[簽名信息](https://developer.android.com/studio/publish/app-signing.html)：
 
-```bash
+```gradle.properties
 storePassword=myStorePassword
 keyPassword=mykeyPassword
 keyAlias=myKeyAlias
 storeFile=myStoreFileLocation
 ```
 
+之後，Linux 或 macOS 上可執行：
+
 ```bash
 make release
 ```
 
+Windows 上執行：
+
+```powershell
+.\gradlew :app:assembleRelease
+```
+
 ### 故障排除
 
 ```
 Target "boost_log_setup" links to target "Boost::coroutine" but the target was not found.
 ```
+在 Linux 或 macOS 上執行 `make clean`，Windows 上執行 `.\gradlew clean`。
 
-執行 `make clean`.
-
-其它問題:
-1. 首先嘗試 `make clean`
-2. 確保你的倉庫與最新版本一致。如果你修改了一個或更多的子模塊，請確保它們與當前倉庫版本兼容。
+其他問題:
+1. 首先嚐試 `make clean`
+2. 確保你的倉庫與最新版本一致。如果你修改了一個或更多的子模組，請確保它們與當前倉庫版本相容。
 3. 如果問題依然存在（不太可能）, 嘗試進行一次新的克隆。
 4. 檢查是否有PR/issue與你的問題相關。 如果有的話，嘗試他們的解決方案。
 5. 如果以上方法都不工作，你可以提一個issue來尋求幫助(可選)。