Spiral: haddock docs

This commit is contained in:
Andrea Rossato 2007-11-23 13:50:23 +00:00
parent 3885445b26
commit de23c9ab0d

View File

@ -30,14 +30,19 @@ import XMonad.Layouts
import XMonad.StackSet ( integrate )
-- $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.Spiral
-- > import Data.Ratio
--
-- > layouts = [ ..., Layout $ spiral (1 % 1), ... ]
-- %import XMonad.Layout.Spiral
-- %layout , Layout $ spiral (1 % 1)
-- Then edit your @layoutHook@ by adding the Spiral layout:
--
-- > myLayouts = spiral (1 % 1) ||| etc..
-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
--
-- For more detailed instructions on editing the layoutHook see:
--
-- "XMonad.Doc.Extending#Editing_the_layout_hook"
fibs :: [Integer]
fibs = 1 : 1 : zipWith (+) fibs (tail fibs)