README.md

   1 # UltimateKEYS Keyboard Layout (Windows)
   2 This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
   3
   4 ## Download the latest version
   5
   6 - **https://github.com/pieter-degroote/UltimateKEYS/releases**
   7
   8
   9 ## Installation Instructions
  10
  11 ### Important - Please note :
  12
  13 - **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
  14
  15 ### Uninstalling a previous version :
  16
  17 In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
  18
  19 1. Remove it from the 'language bar'.
  20 2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
  21 3. Restart your computer.
  22
  23 ### Installing UltimateKEYS :
  24
  25 1. Unpack the ZIP file and run 'setup.exe'.
  26 2. Confirm the UAC (User Account Control) prompt by clicking 'Yes'.
  27 3. Log off and back on.
  28 4. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'.
  29
  30 ## Documentation - Keyboard Layout Image, Dead Key Descriptions
  31
  32 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
  33 - **https://pieter-degroote.github.io/UltimateKEYS/**
  34
  35 ## Script for AutoHotkey
  36
  37 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.
  38
  39 - **AutoHotkey website :  https://www.autohotkey.com/**
  40 - **Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.**
  41 - **After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.**
  42
  43 ## Tools for opening and handling KLC files
  44
  45 The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package.
  46
  47 - **Microsoft Keyboard Layout Creator 1.4 :  https://www.microsoft.com/en-us/download/details.aspx?id=22339**
  48 - **KbdEdit :  http://www.kbdedit.com/**
  49
  50 ## Enjoy and have fun !
  51
  52 Pieter Degroote