Delete UltimateKEYS - 2019-07-20.ahk

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index e2b0255ca5a3c18949bdba93e3e2ded565f67963..49e8ef94b37eade56eac66a37f0393a9716fa29d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,52 @@
 # UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on 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-02-22.zip**
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
 
-### Have fun and enjoy !
+## 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, uninstall it beforehand :
+
+1. Remove it from the 'language bar'.
+2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
+3. Restart your computer.
+
+### Installing UltimateKEYS :
+
+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'.
+
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
+
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
+
+## Script for AutoHotkey
+
+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.**
+
+## 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 !
+
+Pieter Degroote