From 2bb3515bda05e37e084e4bd8e33e549de44b349a Mon Sep 17 00:00:00 2001
From: glasseyes <dglassey@gmail.com>
Date: Mon, 23 Apr 2018 14:48:38 +0700
Subject: [PATCH] initial README and history

---
 linux/README.md  | 64 ++++++++++++++++++++++++++++++++++++++++++++++++
 linux/history.md |  4 +++
 2 files changed, 68 insertions(+)
 create mode 100644 linux/README.md
 create mode 100644 linux/history.md

diff --git a/linux/README.md b/linux/README.md
new file mode 100644
index 0000000000..9d6a5173f8
--- /dev/null
+++ b/linux/README.md
@@ -0,0 +1,64 @@
+# Keyman for Linux
+
+## Projects
+
+ * kmflcomp - KMFL keyboard compiler
+ * libkmfl - core library
+ * ibus-kmfl - IBUS integration to use KMFL
+ * scim\_kmfl\_imengine - deprecated SCIM engine to use KMFL
+
+## Linux Requirements/Setup
+
+Install packages required for building and developing KMFL
+`sudo apt install cdbs debhelper libx11-dev autotools-dev build-essential dh-autoreconf flex bison libibus-1.0-dev`
+
+### Compiling from Command Line
+
+#### Build script
+
+Run `./build.sh` to build and install kmflcomp, libkmfl and ibus-kmfl to `/tmp/kmfl`
+
+set `$INSTALLDIR` to use a different install directory.
+e.g. `INSTALLDIR=/home/me/kmfl ./build.sh`
+
+#### Manually
+
+ * libkmfl requires kmfl.h header from kmflcomp
+ * ibus-kfml requires kmfl.h and headers and lib from libkmfl
+ 
+ So 
+  * kmflcomp must be built and installed before libkmfl
+  * libkmfl must be built and installed before ibus-kmfl
+  
+ For each project run `./configure && make && make install`.
+ 
+ You may prefer to create a different directory to build in and run configure from there e.g. 
+ 
+ `mkdir ../build-kmflcomp;`
+ `cd ../build-kmflcomp`
+ `../kmflcomp/configure` 
+ `make `
+ `make install`
+  
+  The install of ibus-kmfl doesn't install everything to the correct location for it to be used - to be fixed
+
+### Continuous integration
+
+Teamcity will run build.sh
+
+
+### Building packages
+
+TBD, hopefully jenkins
+
+### Testing
+Tests to be created
+
+### Running Keyman for Linux
+
+ * Right-click on the ibus status icon and open `Preferences`.
+ * Select the tab `Input Method`.
+ * Click `Add` to add a keyman keyboard.
+ * Click the 3 dots expander then `Other` which is at the bottom
+ * The list of keyboards will include the Keyman ones
+  
\ No newline at end of file
diff --git a/linux/history.md b/linux/history.md
new file mode 100644
index 0000000000..e6c242412f
--- /dev/null
+++ b/linux/history.md
@@ -0,0 +1,4 @@
+# Keyman for Linux Version History
+
+## 2018-04-23 
+* Import KMFL into Keyman