]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - docs/index.html
Add files via upload
[UltimateKEYS.git] / docs / index.html
index ccbccf78ac63068a8418544a8f26d915f2e1ef06..252d49e4aeac855653506a9f170c065cf92db413 100644 (file)
@@ -20,28 +20,49 @@ line-height: 1.5;
 <body>\r
 <h1>UltimateKEYS Keyboard Layout (Windows)</h1>\r
 \r
-<p>This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.</p>\r
+<p>International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows).</p>\r
 \r
-<p>In UltimateKEYS, all keys are exactly organized as US-QWERTY. When AltGr or AltGr+Shift is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys.</p>\r
+<p>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.</p>\r
 \r
-<p>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 (&#x00b4;) and diaeresis (&#x00a8;) are found under Alt and Alt+Shift respectively.</p>\r
+<p>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 (&#x00b4;) and diaeresis (&#x00a8;) are found under Alt and Alt+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout.</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<h2>Download the latest version</h2>\r
+<h2>Installation - AutoHotkey Script (recommended method)</h2>\r
+\r
+<p>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.</p>\r
 \r
 <ul>\r
-<li style="font-size: 120%;"><a href="https://github.com/pieter-degroote/UltimateKEYS/releases" target="_blank"><strong>Download - UltimateKEYS - Latest Version</strong></a></li>\r
+<li><strong>AutoHotkey website : &nbsp;<a href="https://www.autohotkey.com/" target="_blank">https://www.autohotkey.com/</a></strong></li>\r
+<li><strong>Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.</strong></li>\r
+<li><strong>After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.</strong></li>\r
+<li><strong>Please note : &nbsp;this is an overlay script, specifically designed for the keyboard layout 'US-QWERTY'.</strong></li>\r
 </ul>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<h2>Installation Instructions</h2>\r
+<h2>Download the latest release</h2>\r
+\r
+<ul>\r
+<li style="font-size: 120%;"><a href="https://github.com/pieter-degroote/UltimateKEYS/releases" target="_blank"><strong>Download - UltimateKEYS - Latest Release</strong></a></li>\r
+</ul>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<h2>Documentation - Keyboard Layout Image, Dead Key Descriptions</h2>\r
+\r
+<ul>\r
+<li style="font-size: 120%;"><a href="documentation.html" target="_blank"><strong>Documentation - Keyboard Layout Image, Dead Key Descriptions</strong></a></li>\r
+</ul>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<h2>Installation - Integration in Windows OS using the compiled KLC version (not recommended)</h2>\r
 \r
 <h3>Important - Please note :</h3>\r
 \r
 <ul>\r
-<li style="font-size: 120%;"><strong>The current version(s) should be sufficiently stable and reliable for everyday use, but are <u>NOT</u> certified for mission-critical systems !</strong></li>\r
+<li style="font-size: 120%;"><strong>I prefer the method using the AutoHotkey script as it is a less radical approach to the Windows OS. This second method should <u>NOT</u> be used in a production environment !</strong></li>\r
 </ul>\r
 \r
 <p>&nbsp;</p>\r
@@ -58,7 +79,7 @@ line-height: 1.5;
 \r
 <p>&nbsp;</p>\r
 \r
-<h3>Installing UltimateKEYS :</h3>\r
+<h3>Installing UltimateKEYS (secondary method, not recommended on Win 10) :</h3>\r
 \r
 <ol>\r
 <li>Unpack the ZIP file and run 'setup.exe'.</li>\r
@@ -69,37 +90,6 @@ line-height: 1.5;
 \r
 <p>&nbsp;</p>\r
 \r
-<h2>Documentation - Keyboard Layout Image, Dead Key Descriptions</h2>\r
-\r
-<ul>\r
-<li style="font-size: 120%;"><a href="documentation.html" target="_blank"><strong>Documentation - Keyboard Layout Image, Dead Key Descriptions</strong></a></li>\r
-</ul>\r
-\r
-<p>&nbsp;</p>\r
-\r
-<h2>Script for AutoHotkey</h2>\r
-\r
-<p>In case you prefer this approach, there is also a highly customizable, slimmed down script. Just note that there are no dead keys when using this script (plus some small modifications have been made). To work properly, the Windows keyboard has to be set to standard US-QWERTY.</p>\r
-\r
-<ul>\r
-<li><strong>AutoHotkey website : &nbsp;<a href="https://www.autohotkey.com/" target="_blank">https://www.autohotkey.com/</a></strong></li>\r
-<li><strong>Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository</strong></li>\r
-<li><strong>After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.</strong></li>\r
-</ul>\r
-\r
-<p>&nbsp;</p>\r
-\r
-<h2>Tools for opening and handling KLC files</h2>\r
-\r
-<p>The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package.</p>\r
-\r
-<ul>\r
-<li><strong>Microsoft Keyboard Layout Creator 1.4 : &nbsp;<a href="https://www.microsoft.com/en-us/download/details.aspx?id=22339" target="_blank">https://www.microsoft.com/en-us/download/details.aspx?id=22339</a></strong></li>\r
-<li><strong>KbdEdit : &nbsp;<a href="http://www.kbdedit.com/" target="_blank">http://www.kbdedit.com/</a></strong></li>\r
-</ul>\r
-\r
-<p>&nbsp;</p>\r
-\r
 <h2>Enjoy and have fun !</h2>\r
 \r
 <p>Pieter Degroote</p>\r