]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - README.md
Update README.md
[UltimateKEYS.git] / README.md
index 087786bb709a01527d622ac314182714a26cb44f..93eb22a7d9887378955699e415ec11c87d597ce4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,43 +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 scripts (Win), MSKLC sources (Win, see 'Testing' repository) 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 and Dead Key Descriptions
-
-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-
-## 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 !
+## https://github.com/pieter-degroote/UltimateKEYS-testing