]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - README.md
Delete UltimateKEYS - 2020-04-13.ahk
[UltimateKEYS.git] / README.md
index af561d1a1075f6794485015551562f8b8bd3b3da..3c343e04ee4fda6ab44fbd446638aaa86c4053b3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,20 @@
 # 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)
 
 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.
 
 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 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 adopted several aspects from EurKEY (by Steffen Brüntjen).
 
 
-## Difference between Classic edition and SW edition
+## 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)
+- **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/image-classic.html)
 
 
-- **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)
+- **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/image-sw.html)
 
 ## Script for AutoHotkey (Windows)
 
 
 ## Script for AutoHotkey (Windows)
 
@@ -44,10 +45,11 @@ 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[-sw]` and `rule[-sw].xml` from the 'linux-xkb' folder.
+- 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).
 - 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 !&emsp;-&emsp;Veel plezier !
 
 Pieter Degroote
 
 Pieter Degroote