Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 28dedd19324e08d2e96dfb7c3dcded3769005b31..b2ef48a3537435203afd67550a5630de056f7b48 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,39 @@
 # 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**
 
 
-### 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
+
+- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+
+
+### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
+
+- **KbdEdit :  http://www.kbdedit.com/**
+
+## Enjoy and have fun !