X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/9604929aaeae44df0ae5699b6cf6a68122b95637..5994d6fc0ee3d1b12a541bd72a17d8e89a6e4a2c:/README.md diff --git a/README.md b/README.md index dfc0dec..a95308e 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,26 @@ # UltimateKEYS Keyboard Layout (Windows/Linux) -International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win) script, MSKLC source (Win) and XKB integration (Linux). -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 (Win), MSKLC (Win) and XKB/Xmodmap (Linux). This layout has borrowed some aspects from EurKEY and US-International. -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). +**Official release :** [![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases) +**Testing release :** [![GitHub Testing](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases) -## Script for AutoHotkey (Windows) +## Keyboard Layout Image -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. +![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png) -- **AutoHotkey website :  https://www.autohotkey.com/** -- **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 - 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'.** +=> CP key (blue) :  [Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences) (Multi_key), in combination with AltGr (Right Alt). +=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards. -## Download the latest release +## Important Notice - Security -- **https://github.com/pieter-degroote/UltimateKEYS/releases** +**=> Win/Linux :  Only use "BASIC LATIN" characters (codes 32 to 126) for your Windows, Microsoft Live and Linux passwords !** +Otherwise, it might be impossible to type any Unicode character higher than "Basic Latin" at the login screen/prompt (due to a different keyboard configuration) ! **=> ACCOUNT LOCKOUT** -## Documentation - Keyboard Layout Image, Dead Key Descriptions +**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !** -- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** -- **https://pieter-degroote.github.io/UltimateKEYS/** +## Websites, Documentation and Testing -## MSKLC integration (Windows) +**Websites :  [www.ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/) ~ [www.pieter-degroote.info](https://pieter-degroote.github.io/)** -An MSKLC source file is available for integration on Windows OSes (although not recommended on Windows 10 and not recommended in a production environment). - -## XKB integration (Linux) - -Experimental support for GNU/Linux via XKB integration (X11) :  see the branch 'linux' in this repository. - -## Enjoy and have fun !  -  Veel plezier !  â˜º - -Pieter Degroote +**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**