X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/bab0ee65996264aafeb88b760a0f0039c4ac67e0..8dcfc866048727ddf26c09b118daaa0e4381335d:/README.md

diff --git a/README.md b/README.md
index 3b4d390..9ef7799 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,29 @@
 # UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on US-QWERTY and the EurKEY Keyboard Layout (by Steffen Brüntjen).
+International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source.
 
-### Download the latest version here :
+In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `AltGr` or `AltGr+Shift` is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys.
 
-- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-05-17.zip**
+In that way, it is - somehow - similar to the layout "United States-International" (on Windows), although this project moves all dead key combinations to the modifiers `AltGr` and `AltGr+Shift`. That way, this project solves the most typical issues, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found on `AltGr+'` and `AltGr+Shift+"` respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
 
+## Script for AutoHotkey
 
-### Please note :
+This AutoHotkey script is a highly customizable version of UltimateKEYS. To work properly, the Windows keyboard has to be set to standard US QWERTY and at least AutoHotkey v1.1 (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit') is required.
 
-- **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.**
+- **AutoHotkey website :  https://www.autohotkey.com/**
+- **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**
+- **Download (and run) the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.**
+- **Optionally, you can put the AHK file in the 'Startup' folder to launch at startup.**
+- **Please note :  this is an overlay script, specifically designed for the keyboard layout 'US QWERTY'.**
 
-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+## Download the latest release
 
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
-### Documentation - Keyboard Layout Image :
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
 
-- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
 
+## Enjoy and have fun !  -  Veel plezier !  â˜º
 
-### 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 !
+Pieter Degroote