Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 95bdf942326309f9792a0c611bb218dc3bff1c57..6b03ab52712a727ebbdb5b871a22e8000a1b4169 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,41 @@
-# UltimateKEYS
-A fork based on the EurKEY Keyboard Layout (Windows).
+# UltimateKEYS Keyboard Layout (Windows)
+This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
+
+## Download the latest version
+
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+
+
+## 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 and Dead Key Descriptions
+
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
+
+
+### Tools for handling '.KLC' files (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 !