INSTALL.md

TypeDuck for Windows Development

Prerequisites

• Visual Studio for Desktop development in C++ with components ATL, MFC and Windows XP support.
• cmake
• NSIS for creating installer.

Checkout source code

git clone --recursive https://github.com/TypeDuck-HK/TypeDuck-Windows.git
cd TypeDuck-Windows

Install Boost

install-boost.bat

Setup build environment

Copy env.bat.template to env.bat and edit the file according to your setup. Specifically, make sure BOOST_ROOT is set to the root directory of Boost source tree; modify BJAM_TOOLSET, CMAKE_GENERATOR and PLATFORM_TOOLSET if using a different version of Visual Studio; also set DEVTOOLS_PATH for build tools installed to custom location.

When prepared, do the following in a Developer Command Prompt window.

Build Boost

This is already handled by install-boost.bat.

build.bat boost

Build librime

RIME is the input method engine that powers TypeDuck.

build.bat librime

See this page for a more detailed instructions on building librime.

Alternative: using prebuilt RIME binaries

You may get a copy of prebuilt binaries of librime from the release page of librime. Once downloaded, you can simply copy .dlls / .libs into weasel\output / weasel\lib directories respectively.

Build the application

build.bat weasel hant

Or, create a debug build:

build.bat weasel hant debug

Rebuilding the application:

build.bat weasel hant rebuild

Build with installer:

build.bat weasel hant installer

You may combine the arguments as many as you like, e.g.:

build.bat weasel hant debug rebuild installer

Installer will be generated in the output\archives directory.