1 files changed, 42 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..6c46243
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,42 @@
+= st - simple terminal
+
+st is a simple terminal emulator for X which sucks less.
+
+Patched with:
+
+- anysize
+- blinking cursor
+- clipboard
+- copyurl
+- ligatures
+- scrollback
+- title parsing fix
+- visualbell2
+
+= 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
+
+If you did not install st with make clean install, you must compile
+the st terminfo entry with the following command:
+
+    tic -sx st.info
+
+See the man page for additional details.
+
+= Credits
+
+Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.
+