Add files via upload

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index c29c9aad4847c5927392e359538183b57fb24207..63f1fc8c1e8e51ce81265bae3328834678bad7f4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,55 +1,35 @@
 # 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).
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey (Win), MSKLC (Win) and XKB/Xmodmap (Linux). This layout has borrowed some aspects from EurKEY and US-International.

 
 

-[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
+**Official release :** [![UltimateKEYS Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)  
+**Testing release :** [![Testing Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-testing.svg?label=testing)](https://github.com/pieter-degroote/UltimateKEYS-testing/releases)  
+**Core release :**  [![Core Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS-core.svg?label=core)](https://github.com/pieter-degroote/UltimateKEYS-core/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.
+## Keyboard Layout Image

 
 

-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).
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png)

 
 

-## Difference between Classic and SW (switched) editions
+=> CP key (blue) :  **[Compose Key](https://pieter-degroote.github.io/UltimateKEYS/documentation.html#Compose_Key_Sequences)** (Multi_key), in combination with AltGr (Right Alt) (only with AutoHotkey and Linux).  
+=> Note that the ISO key (next to Left Shift) is not present on standard ANSI keyboards.

 
 

-- **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)
+## MSKLC - Keyboard Layout Image

 
 

-- **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)
+![UltimateKEYS - Keyboard Layout Image](images/UltimateKEYS%20(MSKLC)%20-%20Keyboard%20Layout%20Image.png)

 
 

-## Script for AutoHotkey (Windows)
+=> Without Compose Key, since MSKLC does not support multiple keystrokes as a sequence for a dead key.

 
 

-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.
+## Important Notice - Security

 
 

-- **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'.**
+**=> 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**

 
 

-## Download the latest release
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**

 
 

-- **https://github.com/pieter-degroote/UltimateKEYS/releases**
+## Website, Documentation and Testing

 
 

-## Documentation - Keyboard Layout Image, Dead Key Descriptions
+**Website :  https://pieter-degroote.github.io/**

 
 

-- **https://pieter-degroote.github.io/UltimateKEYS/documentation.html**
-- **https://pieter-degroote.github.io/UltimateKEYS/**
+**Testing repository :  https://github.com/pieter-degroote/UltimateKEYS-testing**

 
 

-## 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/Unpack the files `ultkeys`, `ultkeys-sw`, `rule.xml` 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).
-- Both the Classic (files without '-sw') and SW layouts (files with '-sw') can be installed alongside each other. The user interface will distinguish them as `UltimateKEYS` and `UltimateKEYS SW`.
-
-## Enjoy and have fun ! &nbsp;- &nbsp;Veel plezier ! &nbsp;☺
-
-Pieter Degroote
+**Core repository&nbsp;: &nbsp;https://github.com/pieter-degroote/UltimateKEYS-core**