aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Kummerlaender2015-08-23 21:45:08 +0200
committerAdrian Kummerlaender2015-08-23 21:45:08 +0200
commit77d4b29ffd337b747448ce0f1a6f6e3457d8cd05 (patch)
tree2c8243b454b7014dd95b1ae1787ba3d1ef1ad90e
parent955d972c2dab284883391ff395a92df9c6a06130 (diff)
downloadMetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar.gz
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar.bz2
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar.lz
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar.xz
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.tar.zst
MetaTerm-77d4b29ffd337b747448ce0f1a6f6e3457d8cd05.zip
Add basic usage documentation to README.md
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 56a918a..8d57718 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,20 @@ _MetaTerm_ is implemented in _QML_ and uses [QMLTermWidget](https://github.com/S
![MetaTerm in action](http://static.kummerlaender.eu/media/metaterm_1.png)
+## Usage
+
+_MetaTerm_ starts in insert mode which means that one can simply start typing a command and trigger it's execution by pressing _enter_.
+
+The list of running and killed terminal instances is navigable using _vim-like_ keybindings, i.e. using `j` and `k`. Additionally one can jump to the top using `g` and to the bottom using `G`. Navigation is also accessible in command mode via `:next`, `:prev` and `:jump <INDEX>`.
+
+Insert mode may be entered manually using `i` and exited using `Shift+ESC`. The currently selected terminal instance is killable via `d`. Command mode is entered whenever one presses `:` in normal mode.
+
+A list of all running processes and their respective index is exposed via `:ls`.
+
+Settings may be explored and changed using `:set` in command mode, e.g. the window background is changeable via `:set window background <COLOR>`.
+
+Furthermore _MetaTerm_'s command mode exposes a JavaScript prompt through `:exec <COMMAND>`.
+
## 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_.