From 77d4b29ffd337b747448ce0f1a6f6e3457d8cd05 Mon Sep 17 00:00:00 2001 From: Adrian Kummerlaender Date: Sun, 23 Aug 2015 21:45:08 +0200 Subject: Add basic usage documentation to README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 `. + +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 `. + +Furthermore _MetaTerm_'s command mode exposes a JavaScript prompt through `:exec `. + ## 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_. -- cgit v1.2.3