say it's a fork, add overview of differences

[dwm.git] / README

diff --git a/README b/README
index f7721cf..349fca0 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,21 @@
-dwm - dynamic window manager
-----------------------------
-dwm is an extremely fast, small, and dynamic X11 window manager.
+JasonWoof's fork of dwm - dynamic window manager
+================================================
+dwm is an extremely fast, small, and dynamic window manager for X.
+
+JasonWoof's modifications include:
+
+1.     A new layout that's kinda like deck, but there's a little space above and
+       below the main slave window where you can see (a little bit of) the other
+       slave windows.
+
+2.     When you've got only 1 window in a workspace: by default, it is in the
+       master area. A new tag/attribute is used to specify windows that should use
+       all available space when alone. This results in fewer window resizes, and
+       is nice for applications which are usually not so nice when they're huge
+       (eg firefox, mutt).
+
+3.     _NET_WM_OPACITY is set. Run xcompmgr or the like, so you can see which
+       window has focus. (Non-zero width borders are probably broken in this fork)
 
 
 Requirements
@@ -18,6 +33,9 @@ necessary as root):
 
     make clean install
 
+If you are going to use the default bluegray color scheme it is highly
+recommended to also install the bluegray files shipped in the dextra package.
+
 
 Running dwm
 -----------
@@ -30,22 +48,19 @@ the DISPLAY environment variable is set correctly, e.g.:
 
     DISPLAY=foo.bar:1 exec dwm
 
-This will start dwm on display :1 of the host foo.bar.
-
+(This will start dwm on display :1 of the host foo.bar.)
 
-Displaying status info
-----------------------
 In order to display status info in the bar, you can do something
 like this in your .xinitrc:
 
-    while true
+    while xsetroot -name "`date` `uptime | sed 's/.*,//'`"
     do
-        echo `date` `uptime | sed 's/.*://; s/,//g'`
-        sleep 1
-    done | dwm
+       sleep 1
+    done &
+    exec dwm
 
 
 Configuration
 -------------
-The configuration of dwm is done by customizing its source code
-(grep for the CUSTOMIZE keyword).
+The configuration of dwm is done by creating a custom config.h
+and (re)compiling the source code.