Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 28dedd19324e08d2e96dfb7c3dcded3769005b31..b2cd43004f58f3a283bc5bb00f3a2a201b1eaa9a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,29 @@
-# UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on the EurKEY Keyboard Layout by Steffen Brüntjen.
+# UltimateKEYS Keyboard Layout (Windows/Linux)
 
-### Download the latest version here :
+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-02-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
 
-### Have fun and enjoy !
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
+
+=> CP key (blue) :  **[Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences)** (Multi_key), in combination with AltGr (Right Alt).  
+=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards.
+
+## 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**