X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/034708c521dff4b1be9c583eca8ea80c47e33fe2..d5845c0cbd327063d629a8f2c82a7eff4afddd68:/README.md diff --git a/README.md b/README.md index 7a51c16..0a040f3 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ # UltimateKEYS Keyboard Layout (Windows) -International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows) +International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source. + +In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `AltGr` or `AltGr+Shift` is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys. + +In that way, it is - somehow - similar to the layout "United States-International" (on Windows), although this project moves all dead key combinations to the modifiers `AltGr` and `AltGr+Shift`. That way, this project solves the most typical issues, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found on `AltGr+'` and `AltGr+Shift+"` respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen). ## Script for AutoHotkey -This AutoHotkey script is a highly customizable version of UltimateKEYS. To work properly, the Windows keyboard has to be set to standard US-QWERTY and at least AutoHotkey 1.1 (AutoHotkey_L) is required. +This AutoHotkey script is a highly customizable version of UltimateKEYS. To work properly, the Windows keyboard has to be set to standard US QWERTY and at least AutoHotkey v1.1 (AutoHotkey_L) is required. -- **AutoHotkey website : https://www.autohotkey.com/** +- **AutoHotkey website :  https://www.autohotkey.com/** - **Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.** - **After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.** +- **Please note :  this is an overlay script, specifically designed for the keyboard layout 'US QWERTY'.** ## Download the latest release - **https://github.com/pieter-degroote/UltimateKEYS/releases** +## Documentation - Keyboard Layout Image, Dead Key Descriptions + +- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** +- **https://pieter-degroote.github.io/UltimateKEYS/** + ## Enjoy and have fun ! Pieter Degroote