]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - README.md
Add files via upload
[UltimateKEYS.git] / README.md
index 93eb22a7d9887378955699e415ec11c87d597ce4..d22091737467d49ececf2962ac665b64805f23f6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,27 @@
 # UltimateKEYS Keyboard Layout (Windows/Linux)
 
 # UltimateKEYS Keyboard Layout (Windows/Linux)
 
-International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey scripts (Win), MSKLC sources (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 + .XCompose (Linux). This layout has borrowed some aspects from EurKEY (by Steffen BrĂ¼ntjen).
 
 
-[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
+**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)
 
 
-## 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)
+
+=> CP key (blue) :  [Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences) (Multi_key), in combination with Right Alt or AltGr.  
+=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards.
 
 
-**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
+## 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**
 
 
-## Website :  [ultimatekeys.info  (pieter-degroote.info)](https://pieter-degroote.github.io/UltimateKEYS/)
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
 
 
-## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
+## Websites, Documentation and Testing
 
 
-## Testing Repository - Additional experimental versions :
+**Websites :  [www.ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/) ~ [www.pieter-degroote.info](https://pieter-degroote.github.io/)**
 
 
-## https://github.com/pieter-degroote/UltimateKEYS-testing
+**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**