Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 28dedd19324e08d2e96dfb7c3dcded3769005b31..0a040f3724a54fd88fd1710fe9ba3d7c27c6b0e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
 # 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-24.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 (AutoHotkey_L) is required.
+
+- **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.**
+- **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 !
+
+Pieter Degroote