]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - docs/index.html
Add files via upload
[UltimateKEYS.git] / docs / index.html
index fd51f007a9a2ccb831e6e32cfa638b2c94441955..252d49e4aeac855653506a9f170c065cf92db413 100644 (file)
@@ -20,15 +20,15 @@ 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>Script for AutoHotkey</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
@@ -36,6 +36,7 @@ line-height: 1.5;
 <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
@@ -48,6 +49,47 @@ 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>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>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
+\r
+<h3>Uninstalling a previous version :</h3>\r
+\r
+<p>In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :</p>\r
+\r
+<ol>\r
+<li>Remove it from the 'language bar'.</li>\r
+<li>Uninstall it via 'Control Panel' -&gt; 'Programs and Features'.</li>\r
+<li>Restart your computer.</li>\r
+</ol>\r
+\r
+<p>&nbsp;</p>\r
+\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
+<li>Confirm the UAC (User Account Control) prompt by clicking 'Yes'.</li>\r
+<li>Log off and back on.</li>\r
+<li>Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'.</li>\r
+</ol>\r
+\r
+<p>&nbsp;</p>\r
+\r
 <h2>Enjoy and have fun !</h2>\r
 \r
 <p>Pieter Degroote</p>\r