Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index e37e9e3c2876ab706b44bdba8e4b29e2b763e13f..dfc0dece8757dd49ce531affecbc711f7f42c21f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,52 +1,37 @@
-# 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 (Win) script, MSKLC source (Win) and XKB integration (Linux).

 
 

-## Download the latest version
+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.

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
-
-
-## Installation Instructions
-
-### Important - Please note :
+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).

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+## Script for AutoHotkey (Windows)

 
 

-### Uninstalling a previous version :
+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 case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+- **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'.**

 
 

-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
+## Download the latest release

 
 

-### Installing 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'.
+- **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/**
 
 
 ## Documentation - Keyboard Layout Image, Dead Key Descriptions
 
 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
 - **https://pieter-degroote.github.io/UltimateKEYS/**
 

-## Script for AutoHotkey
-
-In case you prefer this approach, you can find highly customizable, slimmed down script. Just note that there are no dead keys when using this script (plus some small modifications have been made). To work properly, the Windows keyboard has to be set to standard US-QWERTY.
-
-- **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.**
+## MSKLC integration (Windows)

 
 

-## Tools for opening and handling KLC files
+An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and not recommended in a production environment).

 
 

-The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package.
+## XKB integration (Linux)

 
 

-- **Microsoft Keyboard Layout Creator 1.4 :  https://www.microsoft.com/en-us/download/details.aspx?id=22339**
-- **KbdEdit :  http://www.kbdedit.com/**
+Experimental support for GNU/Linux via XKB integration (X11) :  see the branch 'linux' in this repository.

 
 

-## Enjoy and have fun !
+## Enjoy and have fun !  -  Veel plezier !  ☺

 
 Pieter Degroote
 
 Pieter Degroote