Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index d1559e7d5919101651feb5de50762538363fda1c..c29c9aad4847c5927392e359538183b57fb24207 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # UltimateKEYS Keyboard Layout (Windows/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)
 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)


@@ -7,15 +8,23 @@ In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `A
 
 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 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 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/images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
+
+- **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/images/UltimateKEYS%20SW%20-%20Keyboard%20Layout%20Image.png)
+

 ## 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/ / 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').**
 
 - **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'.**
+- **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
 


@@ -28,7 +37,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/or 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)
 


@@ -36,9 +45,10 @@ 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/evdev.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
+- 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 ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
 
 
 ## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺