X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/c3d71e805cb05aac52d2ae5e00ea58a4f2eed283..6617b7680487cfa3d6d56146e7b50ec75ad189d5:/README.md diff --git a/README.md b/README.md index e41c648..b2970c1 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,55 @@ -# UltimateKEYS Keyboard Layout (Windows) -This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout. +# UltimateKEYS Keyboard Layout (Windows/Linux) -## Download the latest version +International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux). -- **https://github.com/pieter-degroote/UltimateKEYS/releases** +[![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). -## Installation Instructions +## Difference between Classic and SW (switched) editions -### Important - Please note : +- **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) -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !** +- **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) -### Uninstalling a previous version : +## Script for AutoHotkey (Windows) -In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand : +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. -1. Remove it from the 'language bar'. -2. Uninstall it via 'Control Panel' -> 'Programs and Features'. -3. Restart your computer. +- **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 \[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'.** -### Installing UltimateKEYS : +## Download the latest release -1. Unpack the ZIP file and run 'setup.exe'. -2. Confirm the UAC (User Account Control) prompt by clicking 'Yes'. -3. Log off and back on. -4. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'. +- **https://github.com/pieter-degroote/UltimateKEYS/releases** ## Documentation - Keyboard Layout Image, Dead Key Descriptions - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** - **https://pieter-degroote.github.io/UltimateKEYS/** -## Script for AutoHotkey +## MSKLC integration (Windows) -In case you prefer this approach, there is also a highly customizable, slimmed down script. Just note that there are no dead keys when using this script (plus some small modifications have been made). To work properly, the Windows keyboard has to be set to standard US-QWERTY. +Two MSKLC source files are available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment). -- **AutoHotkey website : https://www.autohotkey.com/** -- **Download the 'UltimateKEYS - YYYY-MM-DD.ahk' file from this repository** -- **After AutoHotkey is installed, you can optionally put the AHK file in the 'Startup' folder.** +## XKB integration (Linux) -## Tools for opening and handling KLC files +Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository. -The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package. +Follow these steps for experimental integration (at your own risk!) : -- **Microsoft Keyboard Layout Creator 1.4 : https://www.microsoft.com/en-us/download/details.aspx?id=22339** -- **KbdEdit : http://www.kbdedit.com/** +- Download 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 ! +## Enjoy and have fun !  -  Veel plezier !  â˜º Pieter Degroote