README.md

   1 # UltimateKEYS Keyboard Layout (Windows/Linux)
   2 International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux).
   3
   4 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.
   5
   6 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).
   7
   8 ## Script for AutoHotkey (Windows)
   9
  10 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.
  11
  12 - **AutoHotkey website : &nbsp;https://www.autohotkey.com/**
  13 - **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**
  14 - **Download (and run) the "UltimateKEYS - YYYY-MM-DD.ahk" file from this repository.**
  15 - **Optionally, you can put the AHK file in the 'Startup' folder to launch at startup.**
  16 - **Please note : &nbsp;this is an overlay script, specifically designed for the keyboard layout 'US QWERTY'.**
  17
  18 ## Download the latest release
  19
  20 - **https://github.com/pieter-degroote/UltimateKEYS/releases**
  21
  22 ## Documentation - Keyboard Layout Image, Dead Key Descriptions
  23
  24 - **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
  25 - **https://pieter-degroote.github.io/UltimateKEYS/**
  26
  27 ## MSKLC integration (Windows)
  28
  29 An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and not recommended in a production environment).
  30
  31 ## XKB integration (Linux)
  32
  33 Experimental support for GNU/Linux via XKB integration (X11) : &nbsp;see the 'linux-xkb' folder in this repository.
  34
  35 Follow these steps for experimental integration (at your own risk!) :
  36
  37 - Download the files `ultkeys` and `rule.xml` from the 'linux-xkb' folder.
  38 - Copy `ultkeys` to `/usr/share/X11/xkb/symbols` (root required).
  39 - Paste the contents of `rule.xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdex.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
  40
  41 ## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
  42
  43 Pieter Degroote