Delete UltimateKEYS SW - 2020-10-28.ahk

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index af561d1a1075f6794485015551562f8b8bd3b3da..43ec741f4f4823d8035b51e81181fdc027c8c6e7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,53 +1,22 @@
 # 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)
-
-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.
-
-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).
-
-## Difference between Classic edition and SW edition
-
-- **Classic** :  Keeps all standard keys on US QWERTY and adds customizations to the `Right Alt (+Shift)` modifier.
-[**-> Layout image of Classic edition**](https://pieter-degroote.github.io/UltimateKEYS/images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)
-
-- **SW (switched)** :  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).
-[**-> Layout image of SW edition**](https://pieter-degroote.github.io/UltimateKEYS/images/UltimateKEYS%20SW%20-%20Keyboard%20Layout%20Image.png)
-
-## Script for AutoHotkey (Windows)
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win), MSKLC (Win, see 'testing' repository) and XKB integration (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).

 
 

-The 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.
-
-- **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'.**
-
-## 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/**
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)

 
 

-## MSKLC integration (Windows)
+## Important - Security Warning :

 
 

-Two MSKLC source files are available for integration on Windows OSes (although not recommended on Windows 10 and/or in a production environment).
+**=> 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**

 
 

-## XKB integration (Linux)
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-Experimental support for GNU/Linux via XKB integration (X11) :  see the 'linux-xkb' folder in this repository.
+## Website :  [ultimatekeys.info](https://pieter-degroote.github.io/UltimateKEYS/)

 
 

-Follow these steps for experimental integration (at your own risk!) :
+### ([https://pieter-degroote.github.io/UltimateKEYS/](https://pieter-degroote.github.io/UltimateKEYS/))

 
 

-- 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).
+## Releases : &nbsp;https://github.com/pieter-degroote/UltimateKEYS/releases

 
 

-## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
+## Testing Repository - Additional experimental versions :

 
 

-Pieter Degroote
+## https://github.com/pieter-degroote/UltimateKEYS-testing