aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.adoc20
1 files changed, 12 insertions, 8 deletions
diff --git a/README.adoc b/README.adoc
index 6c46243..6aa7c11 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,6 +1,6 @@
-= st - simple terminal
+= davidpkj's simple terminal
-st is a simple terminal emulator for X which sucks less.
+https://st.suckless.org/st[st] is a simple terminal emulator for https://www.x.org/wiki/[X] which sucks less.
Patched with:
@@ -13,11 +13,11 @@ Patched with:
- title parsing fix
- visualbell2
-= Requirements
+== Requirements
In order to build st you need the Xlib header files.
-= Installation
+== Installation
Edit config.mk to match your local setup (st is installed into
the /usr/local namespace by default).
@@ -25,18 +25,22 @@ the /usr/local namespace by default).
Afterwards enter the following command to build and install st (if
necessary as root):
- make clean install
+```bash
+make clean install
+```
-= Running
+== 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
+```bash
+tic -sx st.info
+```
See the man page for additional details.
-= Credits
+== Credits
Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.