Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index e41c6480a1b378b33218a12bb16d87185ead01a5..1908710a3b4a483849dd23c2a6c8625d8f01c743 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,52 +1,20 @@
-# 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 script (Win) and XKB integration (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)

 
 

+## Important - Security Warning :

 
 

-## Installation Instructions
+**=> Win/Linux :  Only use "BASIC LATIN" characters (codes 32 to 126) for the 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

 
 

-### Important - Please note :
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+## Website :  [ultimatekeys.info  (pieter-degroote.info)](https://pieter-degroote.github.io/UltimateKEYS/)

 
 

-### Uninstalling a previous version :
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+## Testing Repository - Additional experimental versions :

 
 

-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
-
-### Installing UltimateKEYS :
-
-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'.
-
-## Documentation - Keyboard Layout Image, Dead Key Descriptions
-
-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-## Script for AutoHotkey
-
-In case you prefer this approach, there is also a highly customizable, slimmed down script. Just note that there are no dead keys when using this script (plus some small modifications have been made). To work properly, the Windows keyboard has to be set to standard US-QWERTY.
-
-- **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.**
-
-## 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 !
-
-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing