From 00b9df5191d1dd421580cc2499a9373aa927cdc6 Mon Sep 17 00:00:00 2001
From: Bartek Fabiszewski <github@fabiszewski.net>
Date: Tue, 27 Sep 2016 14:53:39 +0200
Subject: [PATCH] Update README

---
 README                  |  9 --------
 README.md               | 48 +++++++++++++++++++++++++++++++++++++++++
 layouts/keyboard-kt.xml |  3 ---
 3 files changed, 48 insertions(+), 12 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 979e2ac..0000000
--- a/README
+++ /dev/null
@@ -1,9 +0,0 @@
-This is a simple GTK+ terminal emulator with embedded virtual keyboard. It is based on VteTerminal library. Kterm supports xterm-like "-e" option for running command in terminal. Some initial settings may be defined in kterm.conf file. It is located in the same directory as main binary. Keyboard layouts are defined in xml config files. The keyboard config files follow the same rules as matchbox keyboard configs (kterm 1.x used embedded matchbox keyboard).
-
-Kterm has been developed for Kindle Touch. It is reported to also work on Paperwhites. Generally it should work on any platform which supports GTK+, either version 2 or 3.
-
-Menu pops up on two fingers tap (middle button mouse click) in the terminal window.
-
-Run kterm -h for command line options
-
-Binary packages for Kindle Touch/Paperwhite are available at http://www.fabiszewski.net/kindle-terminal/
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1491d12
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# \# kterm
+
+This is a simple GTK+ terminal emulator with embedded virtual keyboard. It is based on VteTerminal library. Some initial settings may be defined in [kterm.conf](kterm.conf) file. Keyboard layouts are defined in [xml config](layouts/keyboard.xml) files. The keyboard config files follow the same rules as matchbox keyboard configs (backward compatible with kterm 1.x which used embedded matchbox keyboard).
+
+Kterm has been developed for Kindle Touch. It is reported to also work on Paperwhites. Generally it should work on any platform which supports GTK+, either version 2 or 3.
+
+On Kindle menu pops up on two fingers tap in the terminal window. On other devices on right button mouse click.
+
+* [Keyboard XML config](layouts/keyboard.xml) **\<nodes\>** and **attributes**:
+  * **\<layout\>** - layout
+  * **\<row\>** - row
+  * **\<space\>** - empty spacer
+  * **\<key\>** - key, attributes:
+    * **extended** = [true|false], *optional*, if true only visible in landscape mode, defaults to false;
+    * **fill** = [true|false], *optional*, if true button will expand to use all available space, defaults to false;
+    * **width** = [width in kterm units], *optional*, 1000 is standard width, 2000 will be double width key and so on; defaults to 1000;
+    * **obey-caps** = [true|false], *optional*, should button change on caps lock press, defaults to false;
+  * **\<default\>** - default variant (no modifier)
+  * **\<shifted\>** - shifted variant (shift/caps lock modifier pressed)
+  * **\<mod1\>** - mod1 variant (mod1 modifier pressed)
+  * **\<mod2\>** - mod2 variant (mod2 modifier pressed)
+  * **\<mod3\>** - mod3 variant (mod3 modifier pressed)
+    * attributes for all variant nodes (default, shifted, …):
+    * **display** = [character|image\:/path/to/image], *required*, character to display or image path (absolute must start with slash, otherwise relative to config);
+    * **action** = [character|special name|modifier\:name], *required for keys with image label, modifiers, special buttons*, character sent to terminal, name of special action, or name of modifier, defaults to *display* attribute value;
+ 
+ 
+* Command line options:
+```
+$ ./kterm -h
+Usage: kterm [OPTIONS]
+        -c <0|1>     color scheme (0 light, 1 dark)
+        -d           debug mode
+        -e <command> execute command in kterm
+        -E <var>     set environment variable
+        -f <family>  font family
+        -h           show this message
+        -k <0|1>     keyboard off/on
+        -l <path>    keyboard layout config path
+        -s <size>    font size
+        -v           print version and exit
+```
+
+* Binary packages for Kindle Touch/Paperwhite are available at http://www.fabiszewski.net/kindle-terminal/
+
+* GPL license
+
+
diff --git a/layouts/keyboard-kt.xml b/layouts/keyboard-kt.xml
index 3cc767e..c53af57 100755
--- a/layouts/keyboard-kt.xml
+++ b/layouts/keyboard-kt.xml
@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- default keyboard layout for kindle touch -->
 <keyboard>
-  <options>
-    <!-- not yet implemented -->
-  </options>
   <layout id="kt keyboard">
     <row>
       <key fill="true">