aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrea Rossato <andrea.rossato@unibz.it>2007-11-23 13:44:56 +0100
committerAndrea Rossato <andrea.rossato@unibz.it>2007-11-23 13:44:56 +0100
commit88c0428fd0e00d2453359e8a7ef68d4b52fe29ce (patch)
tree2043a5ab426a20793b755f26dc2228131271a558
parentf7cdb0723020e3edfe1e66421818743c233a3a00 (diff)
downloadXMonadContrib-88c0428fd0e00d2453359e8a7ef68d4b52fe29ce.tar.gz
XMonadContrib-88c0428fd0e00d2453359e8a7ef68d4b52fe29ce.tar.xz
XMonadContrib-88c0428fd0e00d2453359e8a7ef68d4b52fe29ce.zip
TilePrime: haddock docs
darcs-hash:20071123124456-32816-aeb10cd0ee56ce4f4c5eb57d2bb0ec0dadad7e4b.gz
-rw-r--r--XMonad/Layout/TilePrime.hs16
1 files changed, 9 insertions, 7 deletions
diff --git a/XMonad/Layout/TilePrime.hs b/XMonad/Layout/TilePrime.hs
index 62fbbce..0029f6f 100644
--- a/XMonad/Layout/TilePrime.hs
+++ b/XMonad/Layout/TilePrime.hs
@@ -31,18 +31,20 @@ import XMonad hiding (trace)
import qualified XMonad.StackSet as W
-- $usage
--- You can use this module with the following in your Config.hs file:
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Layout.TilePrime
--
--- and add the following line to your 'layouts'
+-- Then edit your @layoutHook@ by adding the TilePrime layout:
--
--- > , Layout $ TilePrime nmaster delta ratio False
+-- > myLayouts = TilePrime 1 (3/100) (1/2) False ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
--
--- Use True as the last argument to get a wide layout.
-
--- %import XMonad.Layout.TilePrime
--- %layout , Layout $ TilePrime nmaster delta ratio False
+-- Use @True@ as the last argument to get a wide layout.
+--
+-- For more detailed instructions on editing the layoutHook see:
+--
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
data TilePrime a = TilePrime
{ nmaster :: Int