Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index de77f0c228b38e7718ef1809c70217cd968f8208..5ace84dae4539ac328d876f067688614aa7bf638 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,39 +1,35 @@
-# UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on US-QWERTY and the EurKEY Keyboard Layout (by Steffen Brüntjen).
+# UltimateKEYS Keyboard Layout (Windows/Linux)
 
-## Download the latest version
+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.
 
-- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-06-24.zip**
+**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)
 
+## Keyboard Layout Image
 
-## Installation Instructions
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
 
-### Important - Please note :
+=> 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.
 
-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+## Keyboard Layout Image - MSKLC
 
-### Uninstalling a previous version :
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png)
 
-In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key.
 
-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
+## Important Notice - Security
 
-### Installing UltimateKEYS :
+**=> 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**
 
-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'.
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
 
-## Documentation - Keyboard Layout Image
+## Website, Documentation and Testing
 
-- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+**Website :  https://pieter-degroote.github.io/**
 
+**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**
 
-### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
-
-- **KbdEdit :  http://www.kbdedit.com/**
-
-## Enjoy and have fun !
+**Core repository :  https://github.com/pieter-degroote/UltimateKEYS-core**