aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Layout/Circle.hs
diff options
context:
space:
mode:
Diffstat (limited to 'XMonad/Layout/Circle.hs')
-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 )