Skip to content

Latest commit

 

History

History
140 lines (123 loc) · 5.48 KB

README.md

File metadata and controls

140 lines (123 loc) · 5.48 KB

RIME: Rime Input Method Engine

Build status GitHub release License

Rime with your keystrokes.

Project home

rime.im

License

The 3-Clause BSD License

Features

  • A modular, extensible input method engine in cross-platform C++ code, built on top of open-source technologies
  • Covering features found in a large variety of Chinese input methods, either shape-based or phonetic-based
  • Built with native support for Traditional Chinese, conversion to Simplified Chinese and other regional standards via OpenCC
  • Rime input schema, a DSL in YAML syntax for fast trying out innovative ideas of input method design
  • Spelling Algebra, a mechanism to create variant spelling, especially useful for Chinese dialects
  • Support for chord-typing with a generic Qwerty keyboard

Install

Follow the instructions to build librime on platforms other than Linux:

Build dependencies

  • compiler with C++17 support
  • cmake>=3.12
  • libboost>=1.74
  • libglog>=0.7 (optional)
  • libleveldb
  • libmarisa
  • libopencc>=1.0.2
  • libyaml-cpp>=0.5
  • libgtest (optional)

Runtime dependencies

  • libboost
  • libglog (optional)
  • libleveldb
  • libmarisa
  • libopencc
  • libyaml-cpp

Build and install librime on Linux

make
sudo make install

Frontends

Official:

Community:

Plugins

Related works

  • plum: Rime configuration (recipe) installer
  • combo-pinyin: an innovative chord-typing practice to input Pinyin
  • rime-essay: the preset vocabulary
  • SCU: Squirrel Configuration Utilities

Credits

We are grateful to the makers of the following open source libraries:

Contributors