Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 5f46fcb11f7541beaceeee5290c9e496a28d0c83..6c1b5d47fa7bbf75405247825ed3320927a75b31 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,30 @@
-# UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on the EurKEY Keyboard Layout.
+# 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 + .XCompose (Linux). This layout has borrowed some aspects from EurKEY (by Steffen Brüntjen).

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-04-16.zip**
+**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)

 
 

+## Keyboard Layout Image (Classic) :

 
 

-### Please note :
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)

 
 

-- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.**
+SW (switched) edition :  symbols !, @, #, $, %, ^, &, \*, (, ) are directly accessible; numbers are accessible via Shift.

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+## Important - Security Warning :

 
 

+**=> 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**

 
 

-#### Documentation (about EurKEY 1.3 [beta], 2017) :
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
+## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/)

 
 

-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.**
+**See also :  [https://pieter-degroote.github.io/UltimateKEYS/](https://pieter-degroote.github.io/UltimateKEYS/)**

 
 

-EurKEY website (by Steffen Brüntjen) :  https://eurkey.steffen.bruentjen.eu/
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-### Have fun and enjoy !
+## Testing Repository - Additional experimental versions :
+
+## https://github.com/pieter-degroote/UltimateKEYS-testing