Delete index.html

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index f8db12e5c91efb6a0679fbf3290916d49da7eb6d..84827c3ae18b187018ca12d971c9d0bf349c7e8f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,51 +1,23 @@
 # UltimateKEYS Keyboard Layout (Windows/Linux)
 # UltimateKEYS Keyboard Layout (Windows/Linux)

-International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey script (Win), MSKLC source (Win) and XKB integration (Linux).

 
 

-[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win), MSKLC (Win) and XKB (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).

 
 

-In UltimateKEYS, all keys remain exactly organized as US QWERTY. Except, when `AltGr` (`Right Alt`) or `AltGr+Shift` (`Right Alt + Shift`) is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys.
+**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)

 
 

-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 on `AltGr+'` and `AltGr+Shift+"` respectively. This project has borrowed several aspects from the EurKEY Keyboard Layout (by Steffen Brüntjen).
+## Important - Security Warning :

 
 

-## Difference between classic edition and SW edition
+**=> 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**

 
 

-**Classic** :  Keeps all standard keys on US QWERTY and adds customizations to the `Right Alt (+Shift)` modifier.
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-**SW (switched) edition** :  Also adds customizations to the `Right Alt (+Shift)` modifier, but also makes the symbols !, @, #, $, %, ^, &, \*, ( and ) accessible without holding down Shift. The numbers have moved to Shift (as most computers have a separate numpad).
+## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/)

 
 

-## Script for AutoHotkey (Windows)
+### ([https://pieter-degroote.github.io/UltimateKEYS/](https://pieter-degroote.github.io/UltimateKEYS/))

 
 

-These AutoHotkey scripts are highly customizable editions of UltimateKEYS. To work properly, the Windows keyboard has to be set to standard US QWERTY and at least AutoHotkey v1.1 (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit') is required.
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-- **AutoHotkey website :  https://www.autohotkey.com/ / https://github.com/Lexikos/AutoHotkey_L/releases**
-- **Install the latest release of the current v1.1 branch (preferably as 'Unicode 64-bit', on 32-bit Windows as 'Unicode 32-bit').**
-- **Download (and run) the "UltimateKEYS \[SW\] - YYYY-MM-DD.ahk" file from this repository.**
-- **Optionally, you can put one of the AHK files in the 'Startup' folder to launch at startup.**
-- **Please note :  these are overlay scripts, specifically designed for the keyboard layout 'US QWERTY'.**
+## Testing Repository - Additional experimental versions :

 
 

-## Download the latest release
-
-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
-
-## Documentation - Keyboard Layout Image, Dead Key Descriptions
-
-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
-
-## MSKLC integration (Windows)
-
-Two MSKLC source files are available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment).
-
-## XKB integration (Linux)
-
-Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository.
-
-Follow these steps for experimental integration (at your own risk!) :
-
-- Download the files `ultkeys[-sw]` and `rule[-sw].xml` from the 'linux-xkb' folder.
-- Copy `ultkeys[-sw]` to `/usr/share/X11/xkb/symbols` (root required).
-- Paste the contents of `rule[-sw].xml` to either `/usr/share/X11/xkb/rules/evdev.xml` or `/usr/share/X11/xkb/rules/evdev.extras.xml`, this between the tags `<layoutList>` and `</layoutList>` (root required).
-
-## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
-
-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing