]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - README.md
Delete UltimateKEYS - 2019-12-09.ahk
[UltimateKEYS.git] / README.md
index 8253ce5118e7897a3e9a65ee24e037265da54d81..0d102c0337ecb35c41e96e011d1fb5435afcd545 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,28 @@
 # UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on the EurKEY Keyboard Layout by Steffen Brüntjen.
+International US-QWERTY layout with AltGr dead keys via AutoHotkey script and KLC version (compiled for 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-14.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 issues, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (´) and diaeresis (¨) are found under AltGr and AltGr+Shift respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
 
+## Script for AutoHotkey
 
-#### Documentation (about EurKEY 1.3 [beta], 2017) :
+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.
 
-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
+- **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'.**
 
-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been fixed. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly under combinations with the dead keys.**
+## Download the latest release
 
-EurKEY website :  https://eurkey.steffen.bruentjen.eu/
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
-### Please note :  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.
+## Documentation - Keyboard Layout Image, Dead Key Descriptions
 
-### Have fun and enjoy !
+- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
+- **https://pieter-degroote.github.io/UltimateKEYS/**
+
+## Enjoy and have fun !
+
+Pieter Degroote