-# UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on the EurKEY Keyboard Layout.
+# UltimateKEYS Keyboard Layout (Windows/Linux)
-### Download the latest version here :
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux).
-- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-04-14.zip**
+[](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.
-### Please note :
+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).
-- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.**
+## Difference between Classic and SW (switched) editions
-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+- **Classic** : Keeps all standard keys on US QWERTY and adds customizations to the `Right Alt (+Shift)` modifier.\
+[**-> Layout image of Classic edition**](https://pieter-degroote.github.io/UltimateKEYS/image-classic.html)
+- **SW (switched)** : Also adds customizations to the `Right Alt (+Shift)` modifier, but also makes the symbols !, @, #, $, %, ^, &, \*, ( and ) accessible without holding down Shift. The numbers have moved to Shift (as most computers have a separate numpad).\
+[**-> Layout image of SW edition**](https://pieter-degroote.github.io/UltimateKEYS/image-sw.html)
-#### Documentation (about EurKEY 1.3 [beta], 2017) :
+## Script for AutoHotkey (Windows)
-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
+The AutoHotkey scripts are highly customizable editions 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.
-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.**
+- **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 \[SW\] - YYYY-MM-DD.ahk" file from this repository.**
+- **Optionally, you can put one of the AHK files in the 'Startup' folder to launch at startup.**
+- **Please note : these are overlay scripts, specifically designed for the keyboard layout 'US QWERTY'.**
-EurKEY website (by Steffen Brüntjen) : https://eurkey.steffen.bruentjen.eu/
+## Download the latest release
-### Have fun and enjoy !
+- **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/**
+
+## MSKLC integration (Windows)
+
+Two MSKLC source files are 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 'linux-xkb' folder in this repository.
+
+Follow these steps for experimental integration (at your own risk!) :
+
+- Download/Unpack the files `ultkeys`, `ultkeys-sw`, `rule.xml` and `rule-sw.xml` from the 'linux-xkb' folder.
+- Copy `ultkeys[-sw]` to `/usr/share/X11/xkb/symbols` (root required).
+- Paste the contents of `rule[-sw].xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdev.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
+- Both the Classic (files without '-sw') and SW layouts (files with '-sw') can be installed alongside each other. The user interface will distinguish them as `UltimateKEYS` and `UltimateKEYS SW`.
+
+## Enjoy and have fun ! - Veel plezier !
+
+Pieter Degroote
projects / UltimateKEYS.git / blobdiff