Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index c25c4edc8b614455b4d9b7a2c553d6d855dcd244..9ef7799ac53f2ea0ca8b785dc44072d4bd584e7b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,29 @@
 # UltimateKEYS Keyboard Layout (Windows)
 # UltimateKEYS Keyboard Layout (Windows)

-This project is a fork based on 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-02-21.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

 
 

-### Have fun and enjoy !
+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.
+
+- **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'.**
+
+## Download the latest release
+
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
+
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
+
+## Enjoy and have fun !  -  Veel plezier !  ☺
+
+Pieter Degroote