Delete rule.xml

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 99d5f738828864de068b02f5654275b6ea935174..502f52d5bfde0879e1b456fdf42570e297477f06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,30 @@
-# UltimateKEYS Keyboard Layout (Windows)
-International US QWERTY layout with AltGr dead keys via AutoHotkey script and MSKLC source.
+# 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) and XKB integration (Linux).

 
 

-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
+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.

 
 

-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.
+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 adopted several aspects from EurKEY (by Steffen Brüntjen).

 
 

-- **AutoHotkey website :  https://www.autohotkey.com/**
+## Difference between Classic and SW (switched) editions
+
+- **Classic** :  Keeps all standard keys on US QWERTY and adds customizations to the `Right Alt (+Shift)` modifier.\
+[**-> Layout image of Classic edition**](https://pieter-degroote.github.io/UltimateKEYS/image-classic.html)
+
+- **SW (switched)** :  Also adds customizations to the `Right Alt (+Shift)` modifier, but also makes the symbols !, @, #, $, %, ^, &, \*, ( and ) accessible without holding down Shift. The numbers have moved to Shift (as most computers have a separate numpad).\
+[**-> Layout image of SW edition**](https://pieter-degroote.github.io/UltimateKEYS/image-sw.html)
+
+## Script for AutoHotkey (Windows)
+
+The AutoHotkey scripts are highly customizable editions 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.
+
+- **AutoHotkey website :  https://www.autohotkey.com/ / https://github.com/Lexikos/AutoHotkey_L/releases**

 - **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**
 - **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'.**
+- **Download (and run) the "UltimateKEYS \[SW\] - YYYY-MM-DD.ahk" file from this repository.**
+- **Optionally, you can put one of the AHK files in the 'Startup' folder to launch at startup.**
+- **Please note :  these are overlay scripts, specifically designed for the keyboard layout 'US QWERTY'.**

 
 ## Download the latest release
 
 
 ## Download the latest release
 


@@ -24,6 +35,21 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work
 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
 - **https://pieter-degroote.github.io/UltimateKEYS/**
 
 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
 - **https://pieter-degroote.github.io/UltimateKEYS/**
 

-## Enjoy and have fun !
+## MSKLC integration (Windows)
+
+Two MSKLC source files are available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment).
+
+## XKB integration (Linux)
+
+Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository.
+
+Follow these steps for experimental integration (at your own risk!) :
+
+- Download/Unpack the files `ultkeys`, `ultkeys-sw`, `rule.xml` and `rule-sw.xml` from the 'linux-xkb' folder.
+- Copy `ultkeys[-sw]` to `/usr/share/X11/xkb/symbols` (root required).
+- Paste the contents of `rule[-sw]_xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdev.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
+- Both the Classic (files without '-sw') and SW layouts (files with '-sw') can be installed alongside each other. The user interface will distinguish them as `UltimateKEYS` and `UltimateKEYS SW`.
+
+## Enjoy and have fun !&emsp;-&emsp;Veel plezier !

 
 Pieter Degroote
 
 Pieter Degroote