X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/6ea00ebab423dd691a956b359c5cd98e8d26d19b..79cf0cbfc761579cfe37f70cfeb0368e3641f15b:/README.md?ds=sidebyside diff --git a/README.md b/README.md index c585ef0..1620899 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,51 @@ -# UltimateKEYS Keyboard Layout (Windows) -This project is a fork based on the EurKEY Keyboard Layout. +# 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). -### Download the latest version here : +[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases) -- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-04-16.zip** +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). -### Please note : +## Difference between classic edition and SW edition -- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.** +Classic :  Keeps all standard keys on US QWERTY and adds customizations via the `Right Alt (+Shift)` modifier. -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !** +SW (switched) edition :  Adds customizations via the `Right Alt (+Shift)` modifier, but makes the symbols !, @, #, $, %, ^, &, \*, ( and ) accessible without holding down Shift. The numbers have moved to Shift (as most computers also have a separate numpad). +## Script for AutoHotkey (Windows) -### Documentation : +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. -- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png** +- **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 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 the latest release -#### Additional documentation (about EurKEY 1.3 [beta], 2017) : +- **https://github.com/pieter-degroote/UltimateKEYS/releases** -- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf** -- EurKEY website (by Steffen Brüntjen) : https://eurkey.steffen.bruentjen.eu/ +## Documentation - Keyboard Layout Image, Dead Key Descriptions -**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.** +- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** +- **https://pieter-degroote.github.io/UltimateKEYS/** +## MSKLC integration (Windows) -### Another handy tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) : +Two MSKLC source files are available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment). -- **KbdEdit : http://www.kbdedit.com/** +## XKB integration (Linux) -### Enjoy and have fun ! +Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository. + +Follow these steps for experimental integration (at your own risk!) : + +- 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 `` and `` (root required). + +## Enjoy and have fun !  -  Veel plezier !  â˜º + +Pieter Degroote