X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/46ae2787d0506abde9254945b0d9d4e7cc4b92cc..b58259824a9c242003d6d652c0c338e417570fed:/README.md

diff --git a/README.md b/README.md
index 4d21b9b..06c5981 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +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-24.zip**
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
 
-#### Documentation (about EurKEY 1.3 [beta], 2017) :
+## Installation Instructions
 
-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
+### Important - Please note :
 
-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been fixed. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly under combinations with the dead keys.**
+- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
 
-EurKEY website :  https://eurkey.steffen.bruentjen.eu/
+### Uninstalling a previous version :
 
-### Have fun and enjoy !
+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, slimmed down script. Just note that there are no dead keys when using this script (plus some small modifications have been made). To work properly, the Windows keyboard has to be set to standard US-QWERTY.
+
+- **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