Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 985ee1d5253742af54f9d34eec6fb9febc560d27..b2cd43004f58f3a283bc5bb00f3a2a201b1eaa9a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,33 +1,29 @@
-# 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 (Linux). This layout has borrowed some aspects from EurKEY and US-International.

 
 

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

 
 

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

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+## 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**

 
 

-### Documentation :
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+## Website, Documentation and Testing

 
 

+**Website :  https://pieter-degroote.github.io/**

 
 

-#### Additional documentation (about EurKEY 1.3 [beta], 2017) :
+**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**

 
 

-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
-- EurKEY website (by Steffen Brüntjen) :  https://eurkey.steffen.bruentjen.eu/
-
-**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.**
-
-
-### 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**