X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/932e0fb1bd8f3ddc88ae6e8eb3d70db6703b399d..718d961f1846c798551d14d4cce7a853aecb8f4e:/README.md diff --git a/README.md b/README.md index 99d5f73..2e8213e 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,13 @@ -# UltimateKEYS Keyboard Layout (Windows) -International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source. +# UltimateKEYS Keyboard Layout (Windows/Linux) -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. +International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win, obsolete) and XKB integration (Linux, experimental). -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). +[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases) -## Script for AutoHotkey +## Website :  https://pieter-degroote.github.io/UltimateKEYS/ -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 (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit') is required. +## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases -- **AutoHotkey website :  https://www.autohotkey.com/** -- **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').** -- **Download (and run) the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.** -- **Optionally, you can put the AHK file in the 'Startup' folder to launch at startup.** -- **Please note :  this is an overlay script, specifically designed for the keyboard layout 'US QWERTY'.** +## Testing Repository - Additional experimental versions : -## 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 +## https://github.com/pieter-degroote/UltimateKEYS-testing