Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 9ef7799ac53f2ea0ca8b785dc44072d4bd584e7b..4119f3474132d3eb9ca05ac723ad6f68b6fdfcc2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,20 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source.
+# UltimateKEYS Keyboard Layout (Windows/Linux)
 
-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.
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey scripts (Win), MSKLC sources (Win, see 'Testing' repository) and XKB integration (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).
 
-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).
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
 
-## Script for AutoHotkey
+## Important - Security Warning :
 
-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.
+**=> Win/Linux :  Only use "BASIC LATIN" characters (codes 32 to 126) for the Windows, Microsoft Live and Linux passwords !**  
+Otherwise, it might be impossible to type any Unicode character higher than "Basic Latin" at the login screen/prompt (due to a different keyboard configuration) ! => ACCOUNT LOCKOUT
 
-- **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'.**
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
 
-## Download the latest release
+## Website :  [ultimatekeys.info  (pieter-degroote.info)](https://pieter-degroote.github.io/UltimateKEYS/)
 
-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
 
-## Documentation - Keyboard Layout Image, Dead Key Descriptions
+## Testing Repository - Additional experimental versions :
 
-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-## Enjoy and have fun !  -  Veel plezier !  ☺
-
-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing