aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Layout
diff options
context:
space:
mode:
authorAndrea Rossato <andrea.rossato@unibz.it>2007-11-21 19:14:41 +0100
committerAndrea Rossato <andrea.rossato@unibz.it>2007-11-21 19:14:41 +0100
commit8856ee80639d0bedc670ff49d49435381a2def60 (patch)
treea324750cf645ea5faf6a279ad61d11d33f49ab1d /XMonad/Layout
parentc2a0298b6bc61e46ad09e3ffab50db477fcb5c50 (diff)
downloadXMonadContrib-8856ee80639d0bedc670ff49d49435381a2def60.tar.gz
XMonadContrib-8856ee80639d0bedc670ff49d49435381a2def60.tar.xz
XMonadContrib-8856ee80639d0bedc670ff49d49435381a2def60.zip
Circle: haddock fixes
darcs-hash:20071121181441-32816-ae57bb2de55f4dd95518c6a1398a08180e3d21f1.gz
Diffstat (limited to 'XMonad/Layout')
-rw-r--r--XMonad/Layout/Circle.hs14
1 files changed, 10 insertions, 4 deletions
diff --git a/XMonad/Layout/Circle.hs b/XMonad/Layout/Circle.hs
index 2d85dfc..bc0350f 100644
--- a/XMonad/Layout/Circle.hs
+++ b/XMonad/Layout/Circle.hs
@@ -26,12 +26,18 @@ import XMonad
import XMonad.StackSet (integrate, peek)
-- $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.Circle
--- > layouts = [ Layout Circle ]
-
--- %import XMonad.Layout.Circle
+--
+-- Then edit your @layoutHook@ by adding the Circle layout:
+--
+-- > myLayouts = Circle ||| Full ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
+--
+-- For more detailed instructions on editing the layoutHook see:
+--
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
data Circle a = Circle deriving ( Read, Show )