Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 8830909db9160609aa9680b4a17813d8de67da14..2e8213e15a37a9addfce6c0ffd890de52d31f080 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,13 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows).
+# UltimateKEYS Keyboard Layout (Windows/Linux)

 
 

-In UltimateKEYS, all keys remain exactly organized as US-QWERTY. Except, when AltGr or AltGr+Shift is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys.
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win, obsolete) and XKB integration (Linux, experimental).

 
 

-In that way, it is - somehow - similar to the layout "United States-International" (on Windows), although this project moves all dead key combinations to the modifiers AltGr and AltGr+Shift. That way, this project solves the most typical caveats, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found under Alt and Alt+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout.
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)

 
 

-## Script for AutoHotkey
+## Website :  https://pieter-degroote.github.io/UltimateKEYS/

 
 

-This AutoHotkey script is a highly customizable version of UltimateKEYS. To work properly, the Windows keyboard has to be set to standard US-QWERTY and at least AutoHotkey 1.1 (AutoHotkey_L) is required.
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-- **AutoHotkey website :  https://www.autohotkey.com/**
-- **Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.**
-- **After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.**
-- **Please note :  this is an overlay script, specifically designed for the keyboard layout 'US-QWERTY'.**
+## Testing Repository - Additional experimental versions :

 
 

-## Download the latest release
-
-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
-
-## Documentation - Keyboard Layout Image, Dead Key Descriptions
-
-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-## Enjoy and have fun !
-
-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing