README-mac.md

Rime with Mac

Preparation

Install Xcode with command line tools.

Install other build tools:

brew install cmake
brew install git

Install Boost:

brew install boost

You can also manually download and build Boost libraries from source code, then set BOOST_ROOT to the path of its top level directory prior to building librime.

Get the code

git clone --recursive https://github.com/rime/librime.git

or download from GitHub.

Build third-party libraries

cd librime
make -f Makefile.xcode thirdparty

This builds dependent libraries in thirdparty/src/*, and copies artifacts to thirdparty/lib and thirdparty/bin.

You can build an individual library, eg. opencc, with:

make -f Makefile.xcode thirdparty/opencc

Build librime

make -f Makefile.xcode

This creates xbuild/lib/Release/librime.dylib and command line tools xbuild/bin/Release/rime_*.

Or, make a debug build. This also creates a test in xdebug/test/.

make -f Makefile.xcode debug
# run the test
(cd xdebug/test; ./Debug/rime_test)

Try it in the console

(cd xdebug/bin; echo "congmingdeRime{space}shurufa" | Debug/rime_api_console)

# REPL, quit with Control+d
(cd xdebug/bin; ./Debug/rime_api_console)