Add files via upload

[UltimateKEYS.git] / autohotkey / README.md

diff --git a/autohotkey/README.md b/autohotkey/README.md
index 9300e8cf9a4c2fb6890600079626aced58ab08b0..e5962d46a925b4a802f639b604c994a8571284b8 100644 (file)
--- a/autohotkey/README.md
+++ b/autohotkey/README.md
@@ -1,13 +1,32 @@
 # UltimateKEYS for AutoHotkey v2/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 :

 
 

-When two or more languages/keyboards are installed on the system, the default 'Alt + Shift' sequence will interfere with the AHK scripts.
+**=> AltGr assigned to UltimateKEYS**

 
 

-To avoid this, you can disable the interfering key sequences at :
+- [US QWERTY (Euro)](https://github.com/pieter-degroote/us-qwerty-euro) [![Core Release](https://img.shields.io/github/release/pieter-degroote/us-qwerty-euro.svg)](https://github.com/pieter-degroote/us-qwerty-euro/releases)
+- [US Intl AltGr dead keys](https://github.com/pieter-degroote/us-intl-altgr-dk) [![Core Release](https://img.shields.io/github/release/pieter-degroote/us-intl-altgr-dk.svg)](https://github.com/pieter-degroote/us-intl-altgr-dk/releases)
+- [UltimateKEYS (MSKLC implementation)](https://pieter-degroote.github.io/UltimateKEYS/integration-msklc.html) [![Core Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-core.svg?label=core)](https://github.com/pieter-degroote/UltimateKEYS-core/releases)
+- Hausa (Latin, Nigeria) (based on US QWERTY, see settings)
+- Romanian (Programmers) (based on US QWERTY, see settings)
+- English (India) (based on US QWERTY, see settings)
+- or any other layout that is fully based on US QWERTY

 
 

-*Settings -> Time & Language -> Language -> Spelling, typing & keyboard settings (on the right) -> Advanced keyboard settings -> Input language hot keys*
+**=> Right Alt assigned to UltimateKEYS (secondary choice)**

 
 

-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...
+- United States (US)
+
+Notes :  "Romanian (Programmers)" does not contain some special control codes (Ctrl+\[: u+001b, Ctrl+\\: u+001c, Ctrl+\]: u+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.
+
+**_Note about the standard base US layout :_**
+
+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)