TilePrime.hs: add usage info.

darcs-hash:20071017192612-928c4-16b88a6fed79f3741d3eb1b7df31dce17dfe05af.gz

1 files changed, 19 insertions, 1 deletions

diff --git a/TilePrime.hs b/TilePrime.hs
index 851563d..8e77b2c 100644
--- a/TilePrime.hs
+++ b/TilePrime.hs
@@ -14,7 +14,11 @@
 -- -----------------------------------------------------------------------------
 --
 
-module XMonadContrib.TilePrime (TilePrime(TilePrime)) where
+module XMonadContrib.TilePrime (
+    -- * Usage
+    -- $usage
+    TilePrime(TilePrime)
+    ) where
 
 import Control.Monad (mplus)
 import Data.List (genericLength)
@@ -25,6 +29,20 @@ import XMonad hiding (trace)
 import qualified StackSet as W
 import {-#SOURCE#-} Config (borderWidth)
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.TilePrime
+--
+-- and add the following line to your 'layouts'
+--
+-- > , Layout $ TilePrime nmaster delta ratio False
+--
+-- Use True as the last argument to get a wide layout.
+
+-- %import XMonadContrib.TilePrime
+-- %layout , Layout $ TilePrime nmaster delta ratio False
+
 data TilePrime a = TilePrime
                          { nmaster     :: Int
                          , delta, frac :: Rational