Skip to content

docs: make README build and install instructions match the tree (#832) - #981

Draft
asdf80730 wants to merge 1 commit into
EasyIME:masterfrom
asdf80730:fix/832-readme-build-install
Draft

asdf80730 wants to merge 1 commit into
EasyIME:masterfrom
asdf80730:fix/832-readme-build-install

Conversation

@asdf80730

@asdf80730 asdf80730 commented Oct 22, 2026 •

Copy link
Copy Markdown

Summary

README build and install instructions now match the tree instead of the 2019-era process.

 Tool Requirements
-CMake >= 3.0
-Visual Studio 2019
-Node.js (required for some backends)
+CMake >= 4.2 (VS 2026 generator)
+Visual Studio 2026 + Desktop development with C++
+Node.js + npm (builds bundled JS input methods)
+NSIS 3.x (installer only)

 How to Build
-git submodule update --init
-cmake -G "Visual Studio 16 2019" -A Win32
+git clone --recursive ...
+cmake -G "Visual Studio 18 2026" -A Win32 -DCMAKE_POLICY_VERSION_MINIMUM=3.5
+cmake ... -A x64; cmake ... -A ARM64
+makensis installer\installer.nsi

 Install / Uninstall
-copy DLLs to Program Files, run regsvr32
+run PIME-<version>-setup.exe; uninstall from Settings > Apps

The installer also packages JavaScript input methods that only build.bat generates, so the README now says the manual CMake commands build the C++ binaries only.

Evidence

  • Before: README.md named the Visual Studio 16 2019 generator while build.bat:1,6,11 uses Visual Studio 18 2026; it required pywin32, which no tracked Python file imports (python/python3/requirements.txt is tornado>=6.0); and its install steps copied DLLs and ran regsvr32, while installer/installer.nsi:465-512 registers the TSF service for x86/x64/ARM64 and :526 writes Uninstall.exe.
  • After: git grep -n 'Visual Studio 16 2019\|pywin32' README.md is empty; the three CMake invocations and policy flag match build.bat; makensis installer\installer.nsi matches appveyor.after_build.bat and .github/workflows/build-and-sign.yaml:109; all seven links added by the change return HTTP 200.
  • appveyor.yml:19-24 corroborates the CMake floor: the VS 2026 image ships CMake 4.1, which cannot generate for VS 2026, so CI downloads 4.3.0.

Merge Danger

Door: two-way — README-only, no binaries or workflow changes.

Blast Radius: documentation

Generated with assistance from omp (deepseek-v4.1-flash)

@asdf80730
asdf80730 force-pushed the fix/832-readme-build-install branch from e1207f9 to 08e3035 Compare October 22, 2026 15:28
…IME#832)

The README still documented the Visual Studio 2019 generator, claimed the
Python backend needs pywin32, and told users to copy DLLs and register them
with regsvr32. build.bat builds with the Visual Studio 18 2026 generator,
and the NSIS installer registers the text service, so document those paths
and the CMake version the generator requires.

Generated with assistance from omp (deepseek-v4.1-flash)
@asdf80730
asdf80730 force-pushed the fix/832-readme-build-install branch from 08e3035 to b245596 Compare October 22, 2026 15:29

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant