X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/7f9346d3c02ffa35a8f4daa169dce2a01fa51bd4..9a41c04839f43c2f7a18254ed0bf689198b70db5:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 8ba46e4..3c343e0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # 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 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. +- **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). +- **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) @@ -42,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!) : -- 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 `` and `` (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 !  -  Veel plezier !  â˜º +## Enjoy and have fun ! - Veel plezier ! Pieter Degroote