Structural changes

1 files changed, 52 insertions, 0 deletions

diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..6e05751
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,52 @@
+= davidpkj’s dynamic window manager
+
+https://dwm.suckless.org/dwm[dwm] is a dynamic window manager for https://www.x.org/wiki/[X] which sucks less.
+
+== Requirements
+
+In order to build dwm you need the Xlib header files.
+
+== Installation
+
+Edit config.mk to match your local setup (dwm is installed into
+the /usr/local namespace by default).
+
+Afterwards enter the following command to build and install dwm (if
+necessary as root):
+
+```bash
+make clean install
+```
+
+== Running dwm
+
+Add the following line to your .xinitrc to start dwm using startx:
+
+```bash
+exec dwm
+```
+
+In order to connect dwm to a specific display, make sure that
+the DISPLAY environment variable is set correctly, e.g.:
+
+```bash
+DISPLAY=foo.bar:1 exec dwm
+```
+
+(This will start dwm on display :1 of the host foo.bar.)
+
+In order to display status info in the bar, you can do something
+like this in your .xinitrc:
+
+```bash
+while xsetroot -name "`date` `uptime | sed 's/.*,//'`"
+do
+  sleep 1
+done &
+exec dwm
+```
+
+== Configuration
+
+The configuration of dwm is done by creating a custom config.h
+and (re)compiling the source code.