Third and fourth row Dvorak

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 477ef217a233c7d3d843a0164b65e581c9a71e4b..63f1fc8c1e8e51ce81265bae3328834678bad7f4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,35 @@
 # UltimateKEYS Keyboard Layout (Windows/Linux)
 
-International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win), MSKLC (Win, see 'testing' repository) and XKB integration (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).
+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.
 
-[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
+**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)
 
-## Important - Security Warning :
+## Keyboard Layout Image
 
-**=> 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**
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
 
-**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
+=> 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.
 
-## Website :  [ultimatekeys.info  (pieter-degroote.info)](https://pieter-degroote.github.io/UltimateKEYS/)
+## MSKLC - Keyboard Layout Image
 
-## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png)
 
-## Testing Repository - Additional experimental versions :
+=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key.
 
-## https://github.com/pieter-degroote/UltimateKEYS-testing
+## 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**