Delete UltimateKEYS - 2019-07-27.ahk

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 95bdf942326309f9792a0c611bb218dc3bff1c57..7a51c16b0d60d04f40cb63f9cd1ca76a039274a2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
-# UltimateKEYS
-A fork based on the EurKEY Keyboard Layout (Windows).
+# UltimateKEYS Keyboard Layout (Windows)
+International US-QWERTY layout with AltGr dead keys via AutoHotkey script (Windows)
+
+## Script for AutoHotkey
+
+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.
+
+- **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.**
+
+## Download the latest release
+
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+
+## Enjoy and have fun !
+
+Pieter Degroote