Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 7be4abd3d4fd8f112f29960e07044773dab81c25..99ec6f79ce22f090e18da1abecd24c0bfc10bf0c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,27 @@
 # 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).
 
 # 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).
 

+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](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).
 
 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).
 

+## Difference between Classic edition and SW edition
+
+- **Classic** :  Keeps all standard keys on US QWERTY and adds customizations to the `Right Alt (+Shift)` modifier.
+
+- **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).
+

 ## Script for AutoHotkey (Windows)
 
 ## Script for AutoHotkey (Windows)
 

-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 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/**
+- **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
 


@@ -26,7 +34,7 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work
 
 ## MSKLC integration (Windows)
 
 
 ## 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).
+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)
 
 
 ## XKB integration (Linux)
 


@@ -34,9 +42,9 @@ Experimental support for GNU/Linux via XKB integration (X11) :  see the 'li
 
 Follow these steps for experimental integration (at your own risk!) :
 
 
 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).
+- Download the files `ultkeys[-sw]` 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).

 
 ## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
 
 
 ## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺