aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorterminaldweller <thabogre@gmail.com>2022-04-22 05:23:33 +0000
committerterminaldweller <thabogre@gmail.com>2022-04-22 05:23:33 +0000
commitf6cb39bb7a64a57471e2bbb5b8922e81f00a9772 (patch)
treed57bf3e0ada2b285dd65c1fa260c59e853638231 /README
parentInitial commit (diff)
downloadst-f6cb39bb7a64a57471e2bbb5b8922e81f00a9772.tar.gz
st-f6cb39bb7a64a57471e2bbb5b8922e81f00a9772.zip
initial commit
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6a846ed
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+st - simple terminal
+--------------------
+st is a simple 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
+----------
+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.
+