X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/9604929aaeae44df0ae5699b6cf6a68122b95637..55a33094d0cf4623fe690fcab36efecbee5a5ed1:/README.md diff --git a/README.md b/README.md index dfc0dec..d1559e7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # UltimateKEYS Keyboard Layout (Windows/Linux) -International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win) script, MSKLC source (Win) and XKB integration (Linux). +International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux). + +[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases) In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `AltGr` (`Right Alt`) or `AltGr+Shift` (`Right Alt + Shift`) is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys. @@ -9,9 +11,9 @@ In that way, it is - somehow - similar to the layout "United States-Internationa 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. -- **AutoHotkey website :  https://www.autohotkey.com/** +- **AutoHotkey website :  https://www.autohotkey.com/ / https://github.com/Lexikos/AutoHotkey_L/releases** - **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.** +- **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'.** @@ -26,11 +28,17 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work ## MSKLC integration (Windows) -An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and not recommended in a production environment). +An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment). ## XKB integration (Linux) -Experimental support for GNU/Linux via XKB integration (X11) :  see the branch 'linux' in this repository. +Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository. + +Follow these steps for experimental integration (at your own risk!) : + +- Download the files `ultkeys` and `rule.xml` from the 'linux-xkb' folder. +- Copy `ultkeys` to `/usr/share/X11/xkb/symbols` (root required). +- Paste the contents of `rule.xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdev.extras.xml`, this between the tags `` and `` (root required). ## Enjoy and have fun !  -  Veel plezier !  â˜º