MSVC Windows build & use

[amorphobia]

Background

Fragmented discussions regarding building and usage on Windows took place in #9 and #10. Since pkg-config is a required dependency, yet the official librime releases do not ship a rime.pc file for MSVC builds, additional setup steps are necessary.

I figured it out and added support in my scoop bucket. If you use scoop, you can add my bucket and install librime by

scoop bucket add siku https://github.com/amorphobia/siku
scoop install librime

Then you are ready to build and use pyrime with native MSVC toolchain

# in pyrime dir
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -v .
# or
uv build --wheel

Details

The scoop manifest will do everything described below, but if you prefer not to use scoop, you can setup for yourself.

Create a rime.pc

Put the file in path librime/lib/pkgconfig/rime.pc, where librime is the top directory of librime release.

An example of file content:

prefix=D:/scoop/apps/librime/1.17.0
exec_prefix=D:/scoop/apps/librime/1.17.0
libdir=D:/scoop/apps/librime/1.17.0/lib
includedir=D:/scoop/apps/librime/1.17.0/include
pkgdatadir=D:/scoop/apps/librime/1.17.0/share/rime-data
pluginsdir=D:/scoop/apps/librime/1.17.0/lib/rime-plugins

Name: Rime
Description: Rime Input Method Engine
Version: 1.17.0
Cflags: -I${includedir}
Libs: -L${libdir} -lrime

You should change the paths to real ones in your system. Please note that only forward slashes are allowed.

Add paths to environment variables

• Append the real path of librime/lib/pkgconfig to env var PKG_CONFIG_PATH
• Append the real path of librime to env var CMAKE_PREFIX_PATH
• Append the real path of librime/lib to env var PATH

where librime is the top directory of librime release.

[Freed-Wu]

Thanks! Done by 70e5933

[amorphobia]

Thank you. I forgot to mention that MSVC, cmake (+ninja will be better), python, and pkg-config (or pkg-config-lite) are prerequisites. Anyways, people will figure it out eventually.

[Freed-Wu]

MSVC, cmake (+ninja will be better), python, and pkg-config (or pkg-config-lite) are prerequisites

If anything is missing, you can add a commit/PR to complete 70e5933