Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index e37e9e3c2876ab706b44bdba8e4b29e2b763e13f..46aea43962e7b38c73d0fcc4faddd56efad731fb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,52 +1,30 @@
-# 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 (Win), MSKLC (Win) and XKB/Xmodmap + .XCompose (Linux). This layout has borrowed some aspects from EurKEY (by Steffen Brüntjen).

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+**Official release :** [![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)  
+**Testing release :** [![GitHub Testing](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases)  
+**Legacy release :** [![GitHub Legacy](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-legacy.svg?label=legacy)](https://github.com/pieter-degroote/UltimateKEYS-legacy/releases)

 
 

+## Keyboard Layout Image (Classic) :

 
 

-## Installation Instructions
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)

 
 

-### Important - Please note :
+SW (switched) edition :  symbols !, @, #, $, %, ^, &, \*, (, ) are directly accessible; numbers via Shift.

 
 

-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
+## Important - Security Warning :

 
 

-### Uninstalling a previous version :
+**=> Win/Linux :  Only use “BASIC LATIN” characters (codes 32 to 126) for your 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**

 
 

-In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-1. Remove it from the 'language bar'.
-2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
-3. Restart your computer.
+## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/)

 
 

-### Installing UltimateKEYS :
+**See also :  [https://pieter-degroote.github.io/UltimateKEYS/](https://pieter-degroote.github.io/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'.
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-## Documentation - Keyboard Layout Image, Dead Key Descriptions
+## Testing Repository - Additional experimental versions :

 
 

-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-## Script for AutoHotkey
-
-In case you prefer this approach, you can find 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