X-Git-Url: https://shimmer.witbreuk.eu/gitweb/UltimateKEYS.git/blobdiff_plain/eaf05c190e0c9bdc8f3d3150155b13815abc546b..3516215077ccef0992428f7bd57550a0c588b087:/README.md diff --git a/README.md b/README.md index 07a6439..fe2f5f4 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,28 @@ # UltimateKEYS Keyboard Layout (Windows) -This project is a fork based on US-QWERTY and the EurKEY Keyboard Layout (by Steffen Brüntjen). +International US-QWERTY layout with AltGr dead keys via AutoHotkey script and compiled KLC version (Windows). -### Download the latest version here : +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. -- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-04-22.zip** +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). +## Script for AutoHotkey -### Please note : +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. -- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.** +- **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'.** -- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !** +## Download the latest release +- **https://github.com/pieter-degroote/UltimateKEYS/releases** -### Documentation : +## Documentation - Keyboard Layout Image, Dead Key Descriptions -- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png** +- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html** +- **https://pieter-degroote.github.io/UltimateKEYS/** +## Enjoy and have fun ! -#### Additional documentation (about EurKEY 1.3 [beta], 2017) : - -- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf** -- EurKEY website (by Steffen Brüntjen) : https://eurkey.steffen.bruentjen.eu/ - -**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.** - - -### 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 ! +Pieter Degroote