aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans-Nikolai Viessmann2016-12-13 18:13:29 +0000
committerHans-Nikolai Viessmann2016-12-13 18:13:29 +0000
commit1be8681078bb50d640c6348797f2f3124a31ef27 (patch)
treeb50e8695d6f6dcabb1ee45143f619bf55e701da6
parentd979d46356e656d4fa8c66d299d245f4a01d4808 (diff)
downloadst-me-1be8681078bb50d640c6348797f2f3124a31ef27.tar.gz
st-me-1be8681078bb50d640c6348797f2f3124a31ef27.zip
Updated Readme...
-rw-r--r--README.md (renamed from README)27
1 files changed, 23 insertions, 4 deletions
diff --git a/README b/README.md
index 6a846ed..78e1ce9 100644
--- a/README
+++ b/README.md
@@ -1,26 +1,45 @@
st - simple terminal
---------------------
-st is a simple terminal emulator for X which sucks less.
+====================
+
+About
+-----
+
+`st` is a simple terminal emulator for X which sucks less. Though it works find
+in Wayland as well (with XWayland mind you :-) ).
+
+Main differences with normal branch:
+
+ * patched to have scrollback with basic mousewheel function (Shift+Mousewheel)
+ * patched to support *old schoool* clipboard interaction - in Wayland this does
+ not work well, yet
+ * Personalisation of `config.def.h`
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
+``` bash
+make clean install
+```
+Additionally I have created a PKGBUILD under `archlinux/` for building and
+installing on ArchLinux.
Running st
----------
+
If you did not install st with make clean install, you must compile
the st terminfo entry with the following command:
@@ -30,5 +49,5 @@ See the man page for additional details.
Credits
-------
-Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.
+Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.