Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 7a51c16b0d60d04f40cb63f9cd1ca76a039274a2..18ffe36667c89741e0347132aca4778089a633db 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,28 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows)
+# UltimateKEYS Keyboard Layout (Windows/Linux)
 
-## Script for AutoHotkey
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win), MSKLC (Win) and XKB/Xmodmap + .XCompose (Linux). This layout has borrowed some aspects from EurKEY (by Steffen Brüntjen).
 
-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.
+**Official release :** [![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)  
+**Testing release :** [![GitHub Testing](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases)  
+**Legacy release :** [![GitHub Legacy](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-legacy.svg?label=legacy)](https://github.com/pieter-degroote/UltimateKEYS-legacy/releases)
 
-- **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.**
+## Keyboard Layout Image :
 
-## Download the latest release
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
 
-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+## Important - Security Warning :
 
-## Enjoy and have fun !
+**=> Win/Linux :  Only use "BASIC LATIN" characters (codes 32 to 126) for your 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**
 
-Pieter Degroote
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
+
+## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/)
+
+**See also :  [https://pieter-degroote.github.io/UltimateKEYS/](https://pieter-degroote.github.io/UltimateKEYS/)**
+
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
+
+## Testing Repository - Additional experimental versions :
+
+## https://github.com/pieter-degroote/UltimateKEYS-testing