X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/6d146d04515bdee117e1b4ad6fb0207385d5b92e..4535cebf1625a1e1d7bf2bd394a22da1620a957c:/docs/index.html
diff --git a/docs/index.html b/docs/index.html
index 3a0a31d..252d49e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -20,24 +20,49 @@ line-height: 1.5;
UltimateKEYS Keyboard Layout (Windows)
-This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
+International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows).
+
+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 caveats, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found under Alt and Alt+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout.
+
+
+
+Installation - AutoHotkey Script (recommended method)
+
+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.
+
+
+- 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'.
+
-Download the latest version
+Download the latest release
+
+
+
+Documentation - Keyboard Layout Image, Dead Key Descriptions
+
+
-Installation Instructions
+Installation - Integration in Windows OS using the compiled KLC version (not recommended)
Important - Please note :
-- The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !
+- I prefer the method using the AutoHotkey script as it is a less radical approach to the Windows OS. This second method should NOT be used in a production environment !
@@ -54,7 +79,7 @@ line-height: 1.5;
-Installing UltimateKEYS :
+Installing UltimateKEYS (secondary method, not recommended on Win 10) :
- Unpack the ZIP file and run 'setup.exe'.
@@ -65,26 +90,9 @@ line-height: 1.5;
-Documentation - Keyboard Layout Image, Dead Key Descriptions
-
-
-
-
-
-Tools for opening and handling KLC files
-
-The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package.
-
-
-
-
-
Enjoy and have fun !
+Pieter Degroote
+