From 0510fe293be948c1699bc68a68140923dccfecaa Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Wed, 5 Aug 2015 16:04:20 +0200
Subject: Add basic README.md

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..abf5c9a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# MetaTerm
+
+…is a _prompt like_ user interface enabling running multiple terminal applications at the same time while preserving the sequence of execution. This functionality is controllable in a _vim like_ way in respect of both keybindings and a mode based paradigm.
+
+_MetaTerm_ is implemented in _QML_ and uses [QMLTermWidget](https://github.com/Swordfish90/qmltermwidget) as its embedded terminal emulator.
+
+## Screenshot
+
+![MetaTerm in action](http://static.kummerlaender.eu/media/metaterm_1.png)
+
+## Building
+
+If all requirements are satisfied _MetaTerm_ may be built using a simple chain of _qmake_ and _make_. Alternatively one can also open the provided project file in _QtCreator_.
+
+## Requirements
+
+* Qt 5
+* QMLTermWidget version including support for program arguments
+	* Use [my fork](https://github.com/KnairdA/qmltermwidget) as long as the [pull request](https://github.com/Swordfish90/qmltermwidget/pull/4) is not merged
-- 
cgit v1.2.3