Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 47ff8a887aa9a81ceae9c8b740409239a568446d..c7ed94bfc2cd8f8d4dbfe0b8ff0254ad6d2e571a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work
 
 - **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.**
+- **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'.**
 
@@ -30,7 +30,13 @@ An MSKLC source file is available for integration on Windows OSes (although not
 
 ## XKB integration (Linux)
 
-Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux' branch in this repository.
+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 the files `ultkeys` and `rule.xml` from the 'linux-xkb' 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;☺