Delete UltimateKEYS - 2020-05-30.ahk

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 609acd6c218b413f346154827fc5f18651eb84b4..2e8213e15a37a9addfce6c0ffd890de52d31f080 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,43 +1,13 @@
 # UltimateKEYS Keyboard Layout (Windows/Linux)
-International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux).
 
-In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `AltGr` (`Right Alt`) or `AltGr+Shift` (`Right Alt + 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 issues, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found on `AltGr+'` and `AltGr+Shift+"` respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
 
-## Script for AutoHotkey (Windows)
+## 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 v1.1 (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit') is required.
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
 
-- **AutoHotkey website :  https://www.autohotkey.com/**
-- **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**
-- **Download (and run) the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository.**
-- **Optionally, you can put the AHK file in the 'Startup' folder to launch at startup.**
-- **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/**
-
-## MSKLC integration (Windows)
-
-An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and not recommended in a production environment).
-
-## XKB integration (Linux)
-
-Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux' folder in this repository.
-
-Follow these steps for experimental integration (at your own risk!) :
-
-- Download the files `ultkeys` and `rule.xml` from the 'linux' folder.
-- Copy `ultkeys` to `/usr/share/X11/xkb/symbols` (root required).
-- Paste the contents of `rule.xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdex.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
-
-## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
-
-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing