X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/fdabb528c21a49ea9efbd92fb8085f06df779937..703f9f90b56092cde47f60843841c2506cec6c72:/README.md?ds=sidebyside diff --git a/README.md b/README.md index c18812d..63f1fc8 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,35 @@ -# UltimateKEYS Keyboard Layout (Windows) -This project is a fork based on US-QWERTY and the EurKEY Keyboard Layout (by Steffen Brüntjen). +# UltimateKEYS Keyboard Layout (Windows/Linux) -### Download the latest version here : +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/raw/master/UltimateKEYS%20-%202019-06-24.zip** +**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 -### Installing UltimateKEYS : +![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png) +=> 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. -In case you have already installed a previous version of UltimateKEYS, you need to perform the following steps (otherwise, start with step 4) : +## MSKLC - Keyboard Layout Image -1. Remove it from the 'language bar'. -2. Uninstall it via 'Control Panel' -> 'Programs and Features'. -3. Restart your computer. -4. Unpack the ZIP file and run 'setup.exe'. -5. Confirm the UAC (User Account Control) prompt by clicking 'Yes'. -6. Log off and back on. -7. Optionally, enable UltimateKEYS as the preferred keyboard layout in the 'language bar'. +![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png) +=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key. -### Important - Please note : +## Important Notice - Security -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !** +**=> 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** +**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !** -### Documentation - Keyboard Layout Image : +## Website, Documentation and Testing -- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png** +**Website :  https://pieter-degroote.github.io/** +**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing** -### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) : - -- **KbdEdit : http://www.kbdedit.com/** - -### Enjoy and have fun ! +**Core repository :  https://github.com/pieter-degroote/UltimateKEYS-core**