INSTALL.md

How to Rime with Squirrel

Instructions to build Squirrel - the Rime frontend for Mac OS X

Build Squirrel from Scratch

Prerequisites

You should already have installed Xcode with Command Line Tools.

Install dependencies with Homebrew:

# dev tools:
brew install cmake
brew install git

# libraries:
brew install boost

You can also install them with MacPorts:

port install cmake git
port install boost -no_static

If you've built Boost manually instead of installing it with Homebrew or MacPorts, set BOOST_ROOT to its top level directory in the terminal.

Checkout the code

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

Build dependencies

Build librime, dependent third-party libraries and data files:

make deps

Build Squirrel

make
# or:
#make debug

Install it on your Mac

Once built, you can install and try it live:

sudo make install
# or:
#sudo make install-debug

That's it. Thanks for riming with Squirrel.