path: root/README
diff options
Diffstat (limited to 'README')
1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b38c88b
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+st - simple terminal
+st is a simple terminal emulator for X which sucks less.
+In order to build st you need the Xlib header files.
+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
+If you did not install st with make clean install, you must compile
+the st terminfo entry with the following command:
+ tic -s st.info
+See the man page for additional details.
+Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.