Update README.md

[UltimateKEYS.git] / autohotkey / README.md

diff --git a/autohotkey/README.md b/autohotkey/README.md
index d1e5be0ff146a6418c8d1aa16d54c3a415b20e43..935164213960ad4965f36fbb69bc3d04b66e7748 100644 (file)
--- a/autohotkey/README.md
+++ b/autohotkey/README.md
@@ -1,13 +1,23 @@
-# UltimateKEYS for AutoHotkey v2.0/v1.1
+# UltimateKEYS for AutoHotkey v2/v1.1

 
 

-Prerequisites :
+## Prerequisites

 
 

-The base keyboard layout has to be configured as US QWERTY.
+These AutoHotkey scripts are highly customizable editions of UltimateKEYS. To work properly, the Windows main/base keyboard layout has to be set to either :

 
 

-When two or more languages/keyboards are installed on the system, the default 'Alt + Shift' sequence will interfere with the AHK scripts.
+- **Hausa (Latin, Nigeria)** => AltGr assigned to UltimateKEYS (based on US QWERTY).
+- **Romanian (Programmers)** => AltGr assigned to UltimateKEYS (based on US QWERTY).
+- **English (India)** => AltGr assigned to UltimateKEYS (based on US QWERTY).
+- **United States (US)** => Right Alt assigned to UltimateKEYS (secondary choice).

 
 

-To avoid this, you can disable the interfering key sequences at :
+  (Notes: "Romanian (Programmers)" does not contain some special control codes (Ctrl+\[: u+001b, Ctrl+\\: u+001c, Ctrl+\]: 001d), but I could not find any specific use cases requiring these mappings. "English (India)" also emits an Indian rupee sign (₹) via Ctrl+Shift+4.)

 
 

-*Settings -> Time & Language -> Language -> Spelling, typing & keyboard settings (on the right) -> Advanced keyboard settings -> Input language hot keys*
+**_Note about the standard base US layout :_**

 
 

-Please note that on the standard US QWERTY, the sequence 'Left Alt + Shift' also gets mistakenly triggered by 'Right Alt + Shift', resulting in an unexpected keyboard layout change...
+When two or more languages/keyboards are installed on the system, the default 'Alt + Shift' sequence will interfere with the AHK scripts.  
+To avoid this, you can disable the interfering key sequences at :  
+*Settings -> Time & Language -> Language -> Spelling, typing & keyboard settings (on the right) -> Advanced keyboard settings -> Input language hot keys*  
+Please note that on the standard US QWERTY, the sequence 'Left Alt + Shift' also gets mistakenly triggered by 'Right Alt + Shift', resulting in an unexpected keyboard layout change.
+
+## Keyboard Layout Image
+
+![UltimateKEYS - Keyboard Layout Image](/images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)