X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/3516215077ccef0992428f7bd57550a0c588b087..e67bfc6511da92daf427f53f6f2048563dcebe00:/README.md?ds=sidebyside diff --git a/README.md b/README.md index fe2f5f4..8538d7d 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,24 @@ -# UltimateKEYS Keyboard Layout (Windows) -International US-QWERTY layout with AltGr dead keys via AutoHotkey script and compiled KLC version (Windows). +# UltimateKEYS Keyboard Layout (Windows/Linux) -In UltimateKEYS, all keys remain exactly organized as US-QWERTY. Except, when AltGr or AltGr+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), XKB (Linux) and Xmodmap (Linux). Derived from EurKEY (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 caveats, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found under Alt and Alt+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) +**Legacy release :** [![GitHub Legacy](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-legacy.svg?label=legacy)](https://github.com/pieter-degroote/UltimateKEYS-legacy/releases) -## Script for AutoHotkey +## Important - Security Warning : -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 1.1 (AutoHotkey_L) is required. +**=> 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** -- **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.** -- **Please note :  this is an overlay script, specifically designed for the keyboard layout 'US-QWERTY'.** +**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !** -## Download the latest release +## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/) -- **https://github.com/pieter-degroote/UltimateKEYS/releases** +**Legacy version - Website :  [https://pieter-degroote.github.io/UltimateKEYS-legacy/](https://pieter-degroote.github.io/UltimateKEYS-legacy/)** -## Documentation - Keyboard Layout Image, Dead Key Descriptions +## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases -- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** -- **https://pieter-degroote.github.io/UltimateKEYS/** +## Testing Repository - Additional experimental versions : -## Enjoy and have fun ! - -Pieter Degroote +## https://github.com/pieter-degroote/UltimateKEYS-testing