Update README.md

[UltimateKEYS.git] / autohotkey / README.md

# UltimateKEYS for AutoHotkey v2/v1.1

## Prerequisites

These AutoHotkey scripts are highly customizable editions of UltimateKEYS. To work properly, the Windows main/base keyboard layout has to be set to :

**=> AltGr assigned to UltimateKEYS**

- [US QWERTY (Euro)](https://github.com/pieter-degroote/us-qwerty-euro)
- [US Intl AltGr dead keys](https://github.com/pieter-degroote/us-intl-altgr-dk)
- UltimateKEYS (MSKLC implementation)
- Hausa (Latin, Nigeria) (based on US QWERTY)
- Romanian (Programmers) (based on US QWERTY)
- English (India) (based on US QWERTY)
- or any other layout that is fully based on US QWERTY

**=> Right Alt assigned to UltimateKEYS (secondary choice)**

- 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)