Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 0d102c0337ecb35c41e96e011d1fb5435afcd545..dfc0dece8757dd49ce531affecbc711f7f42c21f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,19 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US-QWERTY layout with AltGr dead keys via AutoHotkey script and KLC version (compiled for Windows).
+# 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).

 
 

-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 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.

 
 

-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 under AltGr and AltGr+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
+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
+## 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 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 (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/**

-- **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'.**
+- **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
 
 
 ## Download the latest release
 


@@ -23,6 +24,14 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work
 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
 - **https://pieter-degroote.github.io/UltimateKEYS/**
 
 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
 - **https://pieter-degroote.github.io/UltimateKEYS/**
 

-## Enjoy and have fun !
+## 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).
+
+## XKB integration (Linux)
+
+Experimental support for GNU/Linux via XKB integration (X11) :  see the branch 'linux' in this repository.
+
+## Enjoy and have fun !  -  Veel plezier !  ☺

 
 Pieter Degroote
 
 Pieter Degroote