Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 7a51c16b0d60d04f40cb63f9cd1ca76a039274a2..5ace84dae4539ac328d876f067688614aa7bf638 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,35 @@
-# 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 (Linux). This layout has borrowed some aspects from EurKEY and US-International.
 
-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 :** [![UltimateKEYS Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)  
+**Testing release :** [![Testing Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases)  
+**Core release :** [![Core Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-core.svg?label=core)](https://github.com/pieter-degroote/UltimateKEYS-core/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**
+=> CP key (blue) :  **[Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences)** (Multi_key), in combination with AltGr (Right Alt) (only with AutoHotkey and Linux).  
+=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards.
 
-## Enjoy and have fun !
+## Keyboard Layout Image - MSKLC
 
-Pieter Degroote
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png)
+
+=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key.
+
+## Important Notice - Security
+
+**=> 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**
+
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
+
+## Website, Documentation and Testing
+
+**Website :  https://pieter-degroote.github.io/**
+
+**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**
+
+**Core repository :  https://github.com/pieter-degroote/UltimateKEYS-core**