Add applied patches to README.md

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..195f6f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# A personal fork of st - the suckless terminal
+
+## Patches
+
+Look at the commit history for more details on how/why these patches
+were applied.
+
++ [font2](https://st.suckless.org/patches/font2/) - allows the
+  definition of fallback fonts;
++ [desktopentry](https://st.suckless.org/patches/desktopentry/) - add
+  desktop entry during installation;
++ [scrollback](https://st.suckless.org/patches/scrollback/) - enables
+  buffer scrollback.
+
+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.
+