Skip to content

Commit

Permalink
Update README-windows.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lotem authored Mar 15, 2024
1 parent 5c7fb64 commit 6d5bbc1
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
tools and libraries:

- Visual Studio 2022 or LLVM 16
- [Boost](http://www.boost.org/)=1.83
- [Boost](http://www.boost.org/)>=1.83
- [cmake](http://www.cmake.org/)>=3.10

Boost and cmake versions need to match higher VS version.
Expand All @@ -23,17 +23,21 @@ or [download from GitHub](https://github.com/rime/librime).
## Setup a 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.
If Boost libraries are available, set `BOOST_ROOT` 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
## Install Boost

This step downloads Boost libraries in librime's default search path.
If you have installed Boost libraries elsewhere, skip this step and set
the environment varialble `BOOST_ROOT` to the installed path.

``` batch
build.bat boost
install-boost.bat
```

## Build third-party libraries
Expand All @@ -51,8 +55,8 @@ build.bat librime
```
This creates `build\bin\Release\rime.dll`.

Build artifacts - the shared library along with API headers and supporting files
are gathered in `dist` directory.
Build artifacts: the shared library along with API headers and supporting files
can be found in `dist` directory.

## Try it in the console

Expand All @@ -61,8 +65,6 @@ is working.

``` batch
cd build\bin
echo congmingdeRime{space}shurufa | Release\rime_api_console.exe > output.txt
Release\rime_api_console.exe
congmingdeRime shurufa
```

Instead of redirecting output to a file, you can set appropriate code page
(`chcp 65001`) and font in the console to work with the REPL interactively.

0 comments on commit 6d5bbc1

Please sign in to comment.