aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Kummerlaender2015-08-05 16:04:20 +0200
committerAdrian Kummerlaender2015-08-05 16:04:20 +0200
commit0510fe293be948c1699bc68a68140923dccfecaa (patch)
treeb7093b9b113e44831ef7edb0b3a120079243b4cf
parent73f1645c860ee0e502ad8a81be5d11854edd6b70 (diff)
downloadMetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar.gz
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar.bz2
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar.lz
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar.xz
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.tar.zst
MetaTerm-0510fe293be948c1699bc68a68140923dccfecaa.zip
Add basic README.md
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
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