Skip to content

INSTALL.md

Latest commit

 

History

History
79 lines (51 loc) · 1.92 KB

INSTALL.md

File metadata and controls

79 lines (51 loc) · 1.92 KB

How to Rime with Weasel

Preparation

  • Install Visual Studio 2017 or newer version for Desktop development in C++ with components ATL, MFC

  • Install dev tools: git, clang-format(>=18.0.0)

  • Download third-party libraries: boost(>=1.78.0)

Optional:

  • install bash via Git for Windows, for installing data files with plum;
  • install NSIS for creating installer.

Checkout source code

Make sure all git submodules are checked out recursively.

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

Build and Install Weasel

Locate weasel source directory.

Setup build environment

Edit your build environment settings in env.bat. You can create the file by copying env.bat.template in the source tree.

Make sure BOOST_ROOT is set to the existing path X:\path\to\boost_<version>.

When using a different version of Visual Studio or platform toolset, un-comment lines to set corresponding variables.

Alternatively, start a Developer Command Prompt window and set environment variables directly in the console, before invocation of build.bat:

set BOOST_ROOT=X:\path\to\boost_N_NN_N

Get prebuilt librime files(headers, libs, pdb and opencc files) with get-rime.ps1 in weasel source directory

powershell .\get-rime.ps1 -use dev

Build

cd weasel
build.bat all

Voila.

Installer will be generated in output\archives directory.

Alternative: using prebuilt Rime binaries

If you've already got a copy of prebuilt binaries of librime, you can simply copy .dlls / .libs into weasel\output / weasel\lib directories respectively, then build Weasel without the all command line option.

build.bat boost data opencc
build.bat weasel

Install and try it live

cd output
install.bat