aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Layout
diff options
context:
space:
mode:
Diffstat (limited to 'XMonad/Layout')
-rw-r--r--XMonad/Layout/Roledex.hs14
1 files changed, 10 insertions, 4 deletions
diff --git a/XMonad/Layout/Roledex.hs b/XMonad/Layout/Roledex.hs
index 0c4eb5f..4c61b5d 100644
--- a/XMonad/Layout/Roledex.hs
+++ b/XMonad/Layout/Roledex.hs
@@ -27,12 +27,18 @@ import Graphics.X11.Xlib
import Data.Ratio
-- $usage
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Layout.Roledex
--- > layouts = [ Layout Roledex ]
-
--- %import XMonad.Layout.Roledex
--- %layout , Layout Roledex
+--
+-- Then edit your @layoutHook@ by adding the Roledex layout:
+--
+-- > myLayouts = Roledex ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
+--
+-- For more detailed instructions on editing the layoutHook see:
+--
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
data Roledex a = Roledex deriving ( Show, Read )