JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
fix keys pressed while kbspawn key is still down
[dwm.git] / README
diff --git a/README b/README
index bd60b68..c38b3d3 100644 (file)
--- a/README
+++ b/README
@@ -1,43 +1,85 @@
-gridwm
-------
+JasonWoof's fork of dwm - dynamic window manager
+================================================
+dwm is an extremely fast, small, and dynamic window manager for X.
 
-gridwm is an extremly fast, small, and automatic X11 window manager.  It
-arranges all windows in a grid.
+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)
+
+4.     Terminals are spawned with environmental variable containing the current
+       workspace number. This can be used to eg have separate shell history per
+       workspace, and/or make terminals stay in their correct workspaces accross
+       dwm restarts.
+
+5.     New windows open to the right (clockwise) of the focused window. Closing
+       the focused window focuses the window to its left (counter-clockwise). This
+       achieves both:
+       
+       1.      After closing a window, focus goes where you expect (it's consistent,
+               and you don't have to remember what was focused before to predict
+               correctly.)
+
+       2.      When you open a window, and then close it, focus goes back to where it
+               was originally.
+       
+       And an added bonus: The master window doesn't move around or change size
+       when you open or close other windows.
 
 
 Requirements
 ------------
-In order to build gridwm you need the Xlib header files.
+In order to build dwm you need the Xlib header files.
 
 
 Installation
 ------------
-Edit config.mk to match your local setup. gridwm is installed into
-the /usr/local namespace by default.
+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 gridwm (if
+Afterwards enter the following command to build and install dwm (if
 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 gridwm
---------------
-Add the following line to your .xinitrc to start gridwm using startx:
+Running dwm
+-----------
+Add the following line to your .xinitrc to start dwm using startx:
 
-    exec gridwm
+    exec dwm
 
-In order to connect gridwm to a specific display, make sure that
+In order to connect dwm to a specific display, make sure that
 the DISPLAY environment variable is set correctly, e.g.:
 
-    DISPLAY=foo.bar:1 exec gridwm
+    DISPLAY=foo.bar:1 exec dwm
+
+(This will start dwm on display :1 of the host foo.bar.)
 
-This will start gridwm 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:
+
+    while xsetroot -name "`date` `uptime | sed 's/.*,//'`"
+    do
+       sleep 1
+    done &
+    exec dwm
 
 
 Configuration
 -------------
-The configuration of gridwm is done by customizing the config.h source file. To
-customize the key bindings edit kb.c. To change the status output, edit the
-status command definition in wm.c.
-
+The configuration of dwm is done by creating a custom config.h
+and (re)compiling the source code.