]> shimmer.witbreuk.eu Git - UltimateKEYS.git/blobdiff - README.md
Add files via upload
[UltimateKEYS.git] / README.md
index 1853e111d4415e593fc5818c268210cc74a2b6f0..b2ef48a3537435203afd67550a5630de056f7b48 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,39 @@
 # UltimateKEYS Keyboard Layout (Windows)
 # UltimateKEYS Keyboard Layout (Windows)
-This project is a fork based on the EurKEY Keyboard Layout.
+This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.
 
 
-### Download the latest version here :
+## Download the latest version
 
 
-- **https://github.com/pieter-degroote/UltimateKEYS/raw/master/UltimateKEYS%20-%202019-04-14.zip**
+- **https://github.com/pieter-degroote/UltimateKEYS/releases**
 
 
 
 
-### Please note :
+## Installation Instructions
 
 
-- **In case you have installed a previous version of UltimateKEYS, you need to uninstall it before, followed by restarting your computer. Then you can continue installing another version.**
+### Important - Please note :
 
 
-- **The current version(s) should be sufficiently stable and reliable for everyday use, but are NOT certified for mission-critical systems !**
+- **The current version(s) should be sufficiently stable and reliable for everyday use, but are _NOT_ certified for mission-critical systems !**
 
 
+### Uninstalling a previous version :
 
 
-#### Documentation (about EurKEY 1.3 [beta], 2017) :
+In case you have already installed a previous version of UltimateKEYS, uninstall it beforehand :
 
 
-- **https://eurkey.steffen.bruentjen.eu/download/windows/1.3/eurkey-layout-complete.pdf**
+1. Remove it from the 'language bar'.
+2. Uninstall it via 'Control Panel' -> 'Programs and Features'.
+3. Restart your computer.
 
 
-**For UltimateKEYS, the majority (99%) of the documentation is the same. In UltimateKEYS, the math symbols have been restored. Furthermore, some additions/changes have been made to support even more letters and symbols, mostly concerning dead key combinations.**
+### Installing UltimateKEYS :
 
 
-EurKEY website (by Steffen Brüntjen) :  https://eurkey.steffen.bruentjen.eu/
+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'.
 
 
-### Have fun and enjoy !
+## Documentation - Keyboard Layout Image
+
+- **https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png**
+
+
+### Another useful tool for handling '.KLC' files (found in the 'source' folder of the UltimateKEYS package) :
+
+- **KbdEdit :  http://www.kbdedit.com/**
+
+## Enjoy and have fun !