]> shimmer.witbreuk.eu Git - UltimateKEYS.git/commitdiff
Update README.md
authorPieter Degroote <pieter-degroote@users.noreply.github.com>
Sat, 4 Apr 2020 16:57:20 +0000 (18:57 +0200)
committerGitHub <noreply@github.com>
Sat, 4 Apr 2020 16:57:20 +0000 (18:57 +0200)
README.md

index d1559e7d5919101651feb5de50762538363fda1c..93a36e5ac6a2bb94552ca923789d38199f192789 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,13 +7,19 @@ 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 (&#x00b4;) and diaeresis (&#x00a8;) are found on `AltGr+'` and `AltGr+Shift+"` respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Br&uuml;ntjen).
 
+## Difference between classic edition and SW edition
+
+Classic : &nbsp;Keeps all standard keys on US QWERTY and adds customizations via the `Right Alt (+Shift)` modifier.
+
+SW (switched) edition : &nbsp;Adds customizations via the `Right Alt (+Shift)` modifier, but makes the symbols !, @, #, $, %, ^, &, \*, ( and ) accessible without holding Shift. The numbers have moved to Shift (as most computers also have a separate numpad).
+
 ## 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.
 
 - **AutoHotkey website : &nbsp;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.**
+- **Download (and run) the "UltimateKEYS \[SW\] - 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 : &nbsp;this is an overlay script, specifically designed for the keyboard layout 'US QWERTY'.**
 
@@ -28,7 +34,7 @@ This AutoHotkey script is a highly customizable version of UltimateKEYS. To work
 
 ## 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)
 
@@ -36,9 +42,9 @@ Experimental support for GNU/Linux via XKB integration (X11) : &nbsp;see the 'li
 
 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 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;☺