Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index d9d0f76be5b665986b60d5932b7e06e7b4476dcb..d1559e7d5919101651feb5de50762538363fda1c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,45 @@
-# UltimateKEYS Keyboard Layout (Windows)
-This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
+# 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).

 
 

-## Download the latest version
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+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.

 
 

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

 
 

-## Installation Instructions
+## Script for AutoHotkey (Windows)

 
 

-### Important - Please note :
+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.

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+- **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').**
+- **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'.**

 
 

-### Uninstalling a previous version :
+## Download the latest release

 
 

-In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**

 
 

-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
+## Documentation - Keyboard Layout Image, Dead Key Descriptions

 
 

-### Installing UltimateKEYS :
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**

 
 

-1. Unpack the ZIP file and run 'setup.exe'.
-2. Confirm the UAC (User Account Control) prompt by clicking 'Yes'.
-3. Log off and back on.
-4. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'.
+## MSKLC integration (Windows)

 
 

-## Documentation - Keyboard Layout Image
+An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment).

 
 

-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
+## 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!) :

 
 

-### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
+- 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/evdev.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).

 
 

-- **KbdEdit :  http://www.kbdedit.com/**
+## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺

 
 

-## Enjoy and have fun !
+Pieter Degroote