aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPetter Rodhelind <petter.rodhelind@gmail.com>2018-02-24 14:16:26 +0100
committerPetter Rodhelind <petter.rodhelind@gmail.com>2018-02-24 14:16:26 +0100
commit9366efa5da152ab9c6686105aaa35cac8b0223d8 (patch)
tree3ea04a4da6a11f12380a015f85a7cbba32961a3e /README.md
parent0c01d0c689183a8d479339e8b69e49de439a92e6 (diff)
downloadpoe-9366efa5da152ab9c6686105aaa35cac8b0223d8.tar.gz
poe-9366efa5da152ab9c6686105aaa35cac8b0223d8.tar.bz2
poe-9366efa5da152ab9c6686105aaa35cac8b0223d8.zip
Add some usage info.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
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.