Delete UltimateKEYS - 2019-12-09.zip

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index b2ef48a3537435203afd67550a5630de056f7b48..0d102c0337ecb35c41e96e011d1fb5435afcd545 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,39 +1,28 @@
 # UltimateKEYS Keyboard Layout (Windows)
-This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
+International US-QWERTY layout with AltGr dead keys via AutoHotkey script and KLC version (compiled for Windows).
 
-## Download the latest version
+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/releases**
-
-
-## Installation Instructions
-
-### Important - Please note :
-
-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+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 AltGr and AltGr+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
 
-### Uninstalling a previous version :
+## Script for AutoHotkey
 
-In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+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.
 
-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
+- **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'.**
 
-### Installing UltimateKEYS :
-
-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'.
-
-## Documentation - Keyboard Layout Image
-
-- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+## Download the latest release
 
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
-### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
 
-- **KbdEdit :  http://www.kbdedit.com/**
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
 
 ## Enjoy and have fun !
+
+Pieter Degroote