readme

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e66cc8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+## st - simple terminal
+This is pinosaur's patched fork of st from suckless.
+
+The following patches are applied:
+- [xresources]{https://st.suckless.org/patches/xresources/}
+- [blinking cursor]{https://st.suckless.org/patches/blinking\_cursor/}
+- [vim browse]{https://st.suckless.org/patches/vim\_browse/}
+- [w3m]{https://st.suckless.org/patches/w3m/}
+
+### Requirements
+In order to build st you need the Xlib header files.
+
+### Installation (make)
+Edit config.mk to match your local setup (st is installed into
+the /usr/local namespace by default).
+
+Then run the following:
+```
+make && sudo make clean install
+```
+
+### Installation (ebuild)
+For Gentoo users, an ebuild will be up on my website sometime.
+The `savedconfig` use flag will be available.
+