X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/0b1bd4b70423082d4b5681e9e5752b16ccb72b38..43531d10972ff1fcb321db036927866ffe52bd74:/README.md diff --git a/README.md b/README.md index b0f157b..90a9b16 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,29 @@ # 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 and MSKLC source. -## Download the latest version +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. -- **https://github.com/pieter-degroote/UltimateKEYS/releases** - - -## Installation Instructions - -### Important - Please note : - -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !** +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). -### Uninstalling a previous version : +## Script for AutoHotkey -In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand : +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. -1. Remove it from the 'language bar'. -2. Uninstall it via 'Control Panel' -> 'Programs and Features'. -3. Restart your computer. +- **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.** +- **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'.** -### Installing UltimateKEYS : +## Download the latest release -1. Unpack the ZIP file and run 'setup.exe'. -2. Confirm the UAC (User Account Control) prompt by clicking 'Yes'. -3. Log off and back on. -4. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'. +- **https://github.com/pieter-degroote/UltimateKEYS/releases** -## Documentation - Keyboard Layout Image +## Documentation - Keyboard Layout Image, Dead Key Descriptions - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** - **https://pieter-degroote.github.io/UltimateKEYS/** - -### Tools for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) : - -- **Microsoft Keyboard Layout Creator 1.4 : https://www.microsoft.com/en-us/download/details.aspx?id=22339** -- **KbdEdit : http://www.kbdedit.com/** - ## Enjoy and have fun ! + +Pieter Degroote