Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 07a64399cf52e4296c8f05b791edfcfde90f5b63..e37e9e3c2876ab706b44bdba8e4b29e2b763e13f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,33 +1,52 @@
 # UltimateKEYS Keyboard Layout (Windows)
 # UltimateKEYS Keyboard Layout (Windows)

-This project is a fork based on US-QWERTY and 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-04-22.zip**
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**

 
 
 
 

-### Please note :
+## Installation Instructions

 
 

-- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.**
+### Important - Please note :

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+- **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 :

 
 

-### Documentation :
+In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :

 
 

-- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+1. Remove it from the 'language bar'.
+2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
+3. Restart your computer.

 
 

+### Installing UltimateKEYS :

 
 

-#### Additional documentation (about EurKEY 1.3 [beta], 2017) :
+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'.

 
 

-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
-- EurKEY website (by Steffen Brüntjen) :  https://eurkey.steffen.bruentjen.eu/
+## Documentation - Keyboard Layout Image, Dead Key Descriptions

 
 

-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.**
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**

 
 

+## Script for AutoHotkey

 
 

-### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
+In case you prefer this approach, you can find 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/**
 
 - **KbdEdit :  http://www.kbdedit.com/**
 

-### Enjoy and have fun !
+## Enjoy and have fun !
+
+Pieter Degroote