From: Daniel Liu <mr.picklepinosaur@gmail.com>
Date: Sun, 31 Jan 2021 16:29:22 +0000 (-0500)
Subject: readme
X-Git-Url: https://git.danieliu.xyz/?p=dwm.git;a=commitdiff_plain;h=d6304d284cbd5c243bbbdc499f9e9dbb98680be1

readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e4bb2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+## dwm - dynamic window manager
+This is pinosaur's patched version of dwm, the suckless window manager.
+
+The following patches are applied:
+- [gaps]{https://dwm.suckless.org/patches/gaps/}
+- [autostart]{https://dwm.suckless.org/patches/autostart/}
+- [xresources]{https://dwm.suckless.org/patches/autostart/}
+- [pertag]{https://dwm.suckless.org/patches/pertag/}
+- [fakefullscreen]{https://dwm.suckless.org/patches/fakefullscreen/}
+- [swallow]{https://dwm.suckless.org/patches/swallow/}
+
+### Requirements
+In order to build dwm you need the Xlib header files.
+
+### Installation (make)
+Edit config.mk to match your local setup (dwm is installed into
+the /usr/local namespace by default).
+
+Then run
+```
+make && sudo make clean install
+```
+
+### Installation (ebuild)
+An ebuild will be available on my website for Gentoo users sometime.
+
+### Running dwm
+Add the following line to your .xinitrc to start dwm using startx:
+```
+exec dwm
+```