From 9366efa5da152ab9c6686105aaa35cac8b0223d8 Mon Sep 17 00:00:00 2001 From: Petter Rodhelind Date: Sat, 24 Feb 2018 14:16:26 +0100 Subject: Add some usage info. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 2cffc7c..e98ca05 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,30 @@ You need [Go](https://golang.org/). Then: Binary distribution may or not be available. As of now, the source should do just fine. +## Usage + +`^Q` exits. + +Everything is text and everything is editable. There are two ways to interact with text, `Run` or `Open`. + +`Open` (`^O` or right-click) will assume the selected text is a file or a directory and will open a new window listing its content. If none is found, it does nothing. + +`Run` (`^R` or middle-click) interprets the text as a command, which can be an internal poe command like `New` or `Del`. If none is found, it does nothing. + +`^S` saves current buffer to disk. + +### Commands + +`New` opens an empty window. + +`Newcol` creates a new column with a new window. + +`Del` closes current window. If it is the last window, the program will exit. + +`Exit` closes all windows and exits the program. + +`!date` executes `date` as a shell command and presents its output in the message window named `+poe`. + ## Bugs Endless. As of now, it is in constant development and things may (and will) break unannounced. Do not use for production. -- cgit v1.2.3