Update README.md

[UltimateKEYS.git] / docs / documentation.html
diff --git a/docs/documentation.html b/docs/documentation.html

index bb05450c71aa1a17aa323d8fa9410958d80b3b89..055cf6eb0c000ba4c62c235b2012d62c1970218f 100644 (file)
--- a/docs/documentation.html
+++ b/docs/documentation.html
@@ -20,6 +20,14 @@ line-height: 1.5;
  <body>\r
  <h1>Documentation - UltimateKEYS Keyboard Layout (Windows)</h1>\r
  \r
+<p>This project is based on US-QWERTY and is forked from the EurKEY Keyboard Layout.</p>\r
+\r
+<p>In UltimateKEYS, all keys are exactly organized as US-QWERTY. When AltGr or AltGr+Shift is pressed in combination with another key, other diacritics and symbols are accessible and some keys become dead keys.</p>\r
+\r
+<p>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 caveats, among which the quotes (' and ") can be used as usual (without pressing the spacebar afterwards), while the acute accent (&#x00b4;) and diaeresis (&#x00a8;) are found under Alt and Alt+Shift respectively.</p>\r
+\r
+<p>&nbsp;</p>\r
+\r
  <h2>Keyboard Layout Image</h2>\r
  \r
  <img src="https://raw.githubusercontent.com/pieter-degroote/UltimateKEYS/master/UltimateKEYS%20-%20Keyboard%20Layout%20Image.png" width="1200" height="482" alt="UltimateKEYS - Keyboard Layout Image.png" />\r
@@ -76,17 +84,17 @@ D -> Ď
  e -> ĕ\r
  E -> Ĕ\r
  ë (AltGr + e) -> ě\r
-Ë (AltGr + E -> Ě\r
+Ë (AltGr + E) -> Ě\r
  g -> ğ\r
  G -> Ğ\r
  é (AltGr + g) -> ǧ\r
-É  (AltGr + G-> Ǧ\r
+É (AltGr + G) -> Ǧ\r
  h -> ȟ\r
  H -> Ȟ\r
  i -> ĭ\r
  I -> Ĭ\r
  ï (AltGr + i) -> ǐ\r
-Ï (AltGr + I -> Ǐ\r
+Ï (AltGr + I) -> Ǐ\r
  j -> ǰ\r
  k -> ǩ\r
  K -> Ǩ\r
@@ -110,7 +118,7 @@ U -> Ŭ
  Ü (AltGr + U) -> Ǔ\r
  z -> ž\r
  Z -> Ž\r
-3 -> ʒ\r
+3 (number 3) -> ʒ\r
  # (Shift + 3) -> Ʒ\r
  º (AltGr + 3) -> ǯ\r
  ³ (AltGr + Shift + 3) -> Ǯ\r
@@ -364,8 +372,8 @@ w -> ẁ
  W -> Ẁ\r
  y -> ỳ\r
  Y -> Ỳ\r
-, -> ¸  (cedilla)\r
-. -> ˛  (ogonek)\r
+, (comma) -> ¸  (cedilla)\r
+. (dot) -> ˛  (ogonek)\r
  (space) -> `  (grave accent)\r
  </pre>\r
  \r
@@ -602,10 +610,10 @@ N -> ⇙
  I -> ⇗\r
  M -> ⇘\r
  + -> ⇔\r
-C -> ¤\r
+C -> ¤  (currency sign)\r
  ä (AltGr + a) -> ₳  (austral sign)\r
  í (AltGr + b) -> ₿  (bitcoin sign)\r
-Ç (AltGr + C) -> ₢  (cruzeiro sign\r
+Ç (AltGr + C) -> ₢  (cruzeiro sign)\r
  ð (AltGr + d) -> ₫  (dong sign)\r
  Ð (AltGr + D) -> ₯  (drachma sign)\r
  è (AltGr + f) -> ₣  (French franc sign)\r
@@ -627,10 +635,10 @@ C -> ¤
  a -> ⅍  (Aktieselskab)\r
  e -> ℮  (estimated symbol)\r
  o -> ℓ  (script small l)\r
-O -> Ω  (ohm)\r
+O -> Ω  (ohm sign)\r
  ç (AltGr + c) -> ℅  (care of)\r
-- -> ⁃  (hyphen bullet)\r
-. -> •  (bullet)\r
+- (hyphen-minus) -> ⁃  (hyphen bullet)\r
+. (dot) -> •  (bullet)\r
  | -> ⁞  (vertical four dots)\r
  (space) -> ¬  (logical negation sign)\r
  </pre>\r