# 同文安卓輸入法平臺/Trime/android-rime
[![自動編譯](https://travis-ci.org/osfans/trime.svg?branch=develop)](https://travis-ci.org/osfans/trime)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

[<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' height='80px'/>](https://play.google.com/store/apps/details?id=com.osfans.trime)

=====
源於開源的[注音倉頡輸入法]前端，
基於著名的[Rime]輸入法框架，
使用JNI的C語言和安卓的java語言書寫，
旨在保護漢語各地方言母語，
音碼形碼通用的輸入法平臺。

## 鳴謝/Credits
- 開發：[osfans](https://github.com/osfans)
- 貢獻：[boboIqiqi](https://github.com/boboIqiqi)、[Bambooin](https://github.com/Bambooin)
- [維基](https://github.com/osfans/trime/wiki)：[xiaoqun2016](https://github.com/xiaoqun2016)、[boboIqiqi](https://github.com/boboIqiqi)
- 翻譯：天真可愛的滿滿（繁體中文）、點解（英文）
- 鍵盤：天真可愛的滿滿、皛筱晓小笨鱼、吴琛11、熊貓阿Bo、默默ㄇㄛˋ
- [捐贈](https://github.com/osfans/trime/releases)：[yueduz](https://github.com/yueduz)、[xiaoqun2016](https://github.com/xiaoqun2016)、[ipcjs](https://github.com/ipcjs)、Anonymous、啸傲居士、 矛矛、[zcunlin](https://github.com/zcunlin)、北冥有鱼、[biopolyhedron](https://github.com/biopolyhedron)、李進、國林、雷、天使的心跳、幸運超人、小雷先生、yeachdata、忠潤、大熊、天真可愛的滿滿（[谷歌開發人員帳號](https://play.google.com/apps/publish/)）
- 社區：在[Issues](https://github.com/osfans/trime/issues)、[貼吧](http://tieba.baidu.com/f?kw=rime)、[酷安](http://www.coolapk.com/apk/com.osfans.trime)、QQ羣中反饋意見的網友
- 項目：[Rime]、[OpenCC]、[注音倉頡輸入法]等開源項目

## 沿革/History
- 最初，輸入法是寫給[泰如拼音](http://tieba.baidu.com/f?kw=%E6%B3%B0%E5%A6%82)（thae5 rv2）的，中文名爲“泰如輸入法”。
- 然後，添加了吳語等方言碼表，做成了一個輸入法平臺，更名爲“漢字方言輸入法”。
- 後來，兼容了五筆、兩筆等形碼，在太空衛士、徵羽的建議下，更名爲“[同文輸入法平臺2.x](https://github.com/osfans/trime-legacy)”。寓意音碼形碼同臺，方言官話同文。
- 之後，藉助JNI技術，享受了[librime](https://github.com/rime/librime)的成果，升級爲“同文輸入法平臺3.x”，簡稱“同文輸入法”。
- 所以，TRIME是Tongwen RIME或是ThaeRvInputMEthod的縮寫。

## 編譯/Build

  Clone the project, **pay attention** it costs long time to clone the project.
  You should wait a long time to complete, and make sure your disk is big enough to hold the source.
  Especially the boost repository, you can change hosts to speed the procedure
  (search hosts in github).
```bash
cd $your_folder
git clone --recursive https://github.com/osfans/trime.git
```

  Now you can build apk(recommended):
```bash
cd $trime_folder
make release
```

  This will just compile android java file and pack the newer resource file.

  librime.so and librime_jni.so will be uploaded by us regularly,
  and you won't worry about the outdated *so files.

  If you want compile the librime.so and librime_jni.so or the source code
  under the 'jni' folder changed by upstream, you can use:
```bash
cd $trime_folder
make apk
```
  And read the guide by different platform to build the *.so files.


- [Arch Linux](https://www.archlinux.org/)
  ```bash
   yaourt -S android-{ndk,sdk,sdk-build-tools,sdk-platform-tools,platform} apache-ant
   make apk
  ```

- Other Linux distributions

  Use the package manager to install the dev environment and Android SDK NDK.

- [Windows Msys2](https://lug.ustc.edu.cn/wiki/mirrors/help/msys2)

  I'm try to build it and someone can improve this guide.

- macOS

  Install Android [SDK](https://developer.android.com/studio/index.html)
  and [NDK](https://developer.android.com/ndk/index.html)
  (You'd better install it by Android Studio or manually instead of by Homebrew).

  Install [Homebrew](http://brew.sh/) and setting
  [USTC mirror](https://lug.ustc.edu.cn/wiki/mirrors/help/brew.git)(Optional) of it.

  Install the basic dev environment and use brew to install others
  (Set the [mirror](https://mirrors.ustc.edu.cn/) can speed up installation).

  ```bash
   brew install automake cmake opencc boost python ant
  ```

  Setting the environment in ~/.bashrc if you use bash like this
  ```bash
   # Android
   export ANDROID_HOME="your_android_sdk"
   export ANDROID_NDK="your_android_ndk"
   export PATH=${PATH}:$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools:$ANDROID_NDK
  ```

  Set the **boost** header folder
  ```bash
   cd $trime_folder/jni/include
   ln -s $your_folder_boost boost
  ```

  (Optional)Set the libreadline.dylib

  If you have the libreadline problem in make process, you should make
  a soft link to your local libreadline.dylib and google it.

  After the project is ready go to the folder and build it yourself.
  ```bash
   cd $trime_folder
   make apk
  ```

  If you have any problems, you can make [issues] (https://github.com/osfans/trime/issues)
   or go to [forum](http://www.coolapk.com/apk/com.osfans.trime).

## 第三方庫/3rd Party Library
- [minilog](http://ceres-solver.org/) (New BSD License)
- [OpenCC](https://github.com/BYVoid/OpenCC) (Apache License 2.0)
- [RIME](http://rime.im) (BSD License)
 - [Boost C++ Libraries](http://www.boost.org/) (Boost Software License)
   - [libiconv](http://www.gnu.org/software/libiconv/) (LGPL License)
 - [darts-clone](https://code.google.com/p/darts-clone/) (New BSD License)
 - [marisa-trie](https://code.google.com/p/marisa-trie/) (BSD License)
 - [UTF8-CPP](http://utfcpp.sourceforge.net/) (Boost Software License)
 - [yaml-cpp](https://code.google.com/p/yaml-cpp/) (MIT License)
 - [LevelDB](https://github.com/google/leveldb) (New BSD License)
   - [snappy](https://google.github.io/snappy/)(BSD License)
 
[注音倉頡輸入法]: https://code.google.com/p/android-traditional-chinese-ime/
[Rime]: http://rime.im
[OpenCC]: https://github.com/BYVoid/OpenCC