aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f28ac3d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# About this project:
+
+This is my fork of [st][stterm] terminal.
+
+### Build requirements:
+
+- Xlib header files
+- fontconfig
+- freetype2
+
+### 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.
+
+[stterm]: https://st.suckless.org