From f955dd353345d4bb7ef39a7b7dee9f57b8f430fb Mon Sep 17 00:00:00 2001 From: Ross Date: Thu, 22 Jun 2023 10:09:51 +1000 Subject: [PATCH] docs(windows): add more steps for clarity --- windows/src/engine/testhost/README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/windows/src/engine/testhost/README.md b/windows/src/engine/testhost/README.md index 0f7c559010..5470f85fca 100644 --- a/windows/src/engine/testhost/README.md +++ b/windows/src/engine/testhost/README.md @@ -1,6 +1,6 @@ # Testhost -This project is a debug host for keyman32 (and keyman64). It is setup to run a single-threaded test mode of keyman32 keystroke processing. It depends on having Keyman correctly installed, but not currently running. Keyboards must be installed as normal. +This project is a debug host for keyman32. It is setup to run a single-threaded test mode of keyman32 keystroke processing. It depends on having Keyman correctly installed, but not currently running. Keyboards must be installed as normal. The primary use of testhost is in interactive debugging of Keyman Core, and intermediate Engine code around Core. The final stage of characters reaching the document will not be identical to Keyman Engine in normal use, and there may be other interactive limitations as well. @@ -8,10 +8,14 @@ Before trying to run, make sure you have built keyman32 in Debug configuration. The work flow that works well using testhost. With Visual Studio(VS) -1. Build Keyman32 with Debug Configuration. -2. Build testhost with Debug Configuration. -3. Ensure Keyman is not running and that language associated with keyboard you want to test is not selected in the language bar. -4. Press F5 to start debugging. -5. Now use the language bar to select the language associated with a keyman keyboard. -6. You should now be able to debug both the platform and keyman core code. -7. Once you stop the debug session you will need to go back to step 3 to start a new session. (or step 1 if you are making code changes; you should not need to reboot windows.) +1. Open the ..\keyman\app\windows\src\engine.sln +2. Build Keyman32 with Debug Configuration. +3. Build testhost with Debug Configuration. +4. Set testhost as Startup Project and configuration an Debug +5. Ensure Keyman is not running and that language associated with keyboard you want to test is not selected in the language bar. +6. Press F5 to start debugging. +7. Now use the language bar to select the language associated with a keyman keyboard. +8. You should now be able to debug both the platform and keyman core code. +9. Once you stop the debug session you will need to go back to step 3 to start a new session. (or step 1 if you are making code changes; you should not need to reboot windows.) + +Note: a good first break point in is in kmprocess.cpp and then inside ProcessHook() function.