X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/f63aca9eccb6542096a126028ea0c035441ceaf5..c75614192afa2eb434fae3b80da94d13edecb378:/README.md diff --git a/README.md b/README.md index 087786b..63f1fc8 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,35 @@ -# 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 (Win), MSKLC (Win) and XKB/Xmodmap (Linux). This layout has borrowed some aspects from EurKEY and US-International. -- **https://github.com/pieter-degroote/UltimateKEYS/releases** +**Official release :** [![UltimateKEYS Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases) +**Testing release :** [![Testing Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases) +**Core release :**  [![Core Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-core.svg?label=core)](https://github.com/pieter-degroote/UltimateKEYS-core/releases) +## Keyboard Layout Image -## Installation Instructions +![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png) -### Important - Please note : +=> CP key (blue) :  **[Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences)** (Multi_key), in combination with AltGr (Right Alt) (only with AutoHotkey and Linux). +=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards. -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !** +## MSKLC - Keyboard Layout Image -### Uninstalling a previous version : +![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png) -In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand : +=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key. -1. Remove it from the 'language bar'. -2. Uninstall it via 'Control Panel' -> 'Programs and Features'. -3. Restart your computer. +## Important Notice - Security -### Installing UltimateKEYS : +**=> 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** -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'. +**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !** -## Documentation - Keyboard Layout Image and Dead Key Descriptions +## Website, Documentation and Testing -- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** -- **https://pieter-degroote.github.io/UltimateKEYS/** +**Website :  https://pieter-degroote.github.io/** +**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing** -## Tools for opening and handling KLC files - -The source '.KLC' file is found in the 'source' folder of the UltimateKEYS package. - -- **Microsoft Keyboard Layout Creator 1.4 : https://www.microsoft.com/en-us/download/details.aspx?id=22339** -- **KbdEdit : http://www.kbdedit.com/** - -## Enjoy and have fun ! +**Core repository :  https://github.com/pieter-degroote/UltimateKEYS-core**