X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/fdabb528c21a49ea9efbd92fb8085f06df779937..0c29a8044ae2bbc049c66702af467587e6ec6f42:/README.md?ds=sidebyside diff --git a/README.md b/README.md index c18812d..49e8ef9 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,52 @@ # UltimateKEYS Keyboard Layout (Windows) -This project is a fork based on US-QWERTY and the EurKEY Keyboard Layout (by Steffen Brüntjen). +This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout. -### Download the latest version here : +## Download the latest version -- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-06-24.zip** +- **https://github.com/pieter-degroote/UltimateKEYS/releases** -### Installing UltimateKEYS : +## 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 !** +### Uninstalling a previous version : -In case you have already installed a previous version of UltimateKEYS, you need to perform the following steps (otherwise, start with step 4) : +In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand : 1. Remove it from the 'language bar'. 2. Uninstall it via 'Control Panel' -> 'Programs and Features'. 3. Restart your computer. -4. Unpack the ZIP file and run 'setup.exe'. -5. Confirm the UAC (User Account Control) prompt by clicking 'Yes'. -6. Log off and back on. -7. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'. +### Installing UltimateKEYS : -### Important - Please note : +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'. -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !** +## Documentation - Keyboard Layout Image, Dead Key Descriptions +- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** +- **https://pieter-degroote.github.io/UltimateKEYS/** -### Documentation - Keyboard Layout Image : +## Script for AutoHotkey -- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png** +In case you prefer this approach, there is also a highly customizable AutoHotkey script available. 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.** -### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) : +## Tools for opening and handling KLC files +The source '.KLC' file is 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 ! +## Enjoy and have fun ! + +Pieter Degroote