basic docs for Grid

darcs-hash:20071005225934-42ea9-75e6fd22c0c3b2efd5f10afe25537e11a9482e8c.gz

1 files changed, 15 insertions, 0 deletions

diff --git a/Grid.hs b/Grid.hs
index e4dcd11..6fc47f8 100644
--- a/Grid.hs
+++ b/Grid.hs
@@ -8,10 +8,13 @@
 -- Stability   :  unstable
 -- Portability :  unportable
 --
+-- A simple layout that attempts to put all windows in a square grid.
 --
 -----------------------------------------------------------------------------
 
 module XMonadContrib.Grid (
+    -- * Usage
+    -- $usage
 	Grid(..)
 ) where
 
@@ -19,6 +22,18 @@ import XMonad
 import StackSet
 import Graphics.X11.Xlib.Types
 
+-- $usage
+-- Put the following in your Config.hs file:
+--
+-- > import XMonadContrib.Grid
+-- > ...
+-- > defaultLayouts = [ ...
+-- >                  , Layout Grid
+-- >                  ]
+
+-- %import XMonadContrib.Grid
+-- %layout , Layout Grid
+
 data Grid a = Grid deriving (Read, Show)
 
 instance LayoutClass Grid a where