X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/034708c521dff4b1be9c583eca8ea80c47e33fe2..e2b3d60186db775979a3193daf6e1ff2d6e6a108:/README.md

diff --git a/README.md b/README.md
index 7a51c16..d1419dc 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,43 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows)
+# UltimateKEYS Keyboard Layout (Windows/Linux)
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux).
 
-## Script for AutoHotkey
+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.
 
-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.
+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).
 
-- **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.**
+## Script for AutoHotkey (Windows)
+
+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/**
+- **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'.**
 
 ## Download the latest release
 
 - **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
-## Enjoy and have fun !
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
+
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
+
+## MSKLC integration (Windows)
+
+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 '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 `<layoutList>` and `</layoutList>` (root required).
+
+## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
 
 Pieter Degroote