backport of local changes

[st.git] / README

diff --git a/README b/README
new file mode 100644 (file)
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.