Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 7a51c16b0d60d04f40cb63f9cd1ca76a039274a2..90a9b16813213d2e67d838a09728b068f004d6e2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,29 @@
 # UltimateKEYS Keyboard Layout (Windows)
 # UltimateKEYS Keyboard Layout (Windows)

-International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows)
+International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source.
+
+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 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
 

-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/**
+- **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**

 - **Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.**
 - **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.**
+- **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**
 
 
 ## 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
 ## Enjoy and have fun !
 
 Pieter Degroote