aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAnselm R Garbe <garbeam@gmail.com>2009-05-10 13:17:09 +0100
committerAnselm R Garbe <garbeam@gmail.com>2009-05-10 13:17:09 +0100
commitd58dd3b8bc42ed31232e4145696d7dacb117a31c (patch)
treedfe3362a600e9491a687cd765158b70d3328333d /README
parent802f1922f93aef1e4876719e107828a1fa15b1a6 (diff)
downloadst-d58dd3b8bc42ed31232e4145696d7dacb117a31c.tar.gz
backport of local changes
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..09a7fff
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+st - simple terminal
+--------------------
+st is a simple virtual terminal emulator for X which sucks less.
+
+
+Requirements
+------------
+In order to build st you need the Xlib header files.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (st is installed into
+the /usr/local namespace by default).
+
+Afterwards enter the following command to build and install st (if
+necessary as root):
+
+ make clean install
+
+
+Running st
+----------
+See the man page for details.
+
+Credits
+-------
+Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.