Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 3b4d390e7f6bac07ec3c62ea477664eb9c98e5d8..26eeb12ae89313e6293561b9fb1fcfde3b405936 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,28 @@
 # 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).
+International US-QWERTY layout with AltGr dead keys via AutoHotkey script and compiled KLC version (Windows).

 
 

-### 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 under Alt and Alt+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 1.1 (AutoHotkey_L) 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/**
+- **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'.**

 
 

-- **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 !

 
 

-### 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