diff --git a/Documentation.hs b/Documentation.hs index b8485eb9..9aa0b05a 100644 --- a/Documentation.hs +++ b/Documentation.hs @@ -6,7 +6,7 @@ -- -- Maintainer : andrea.rossato@unibz.it -- Stability : unstable --- Portability : unportable +-- Portability : portable -- -- This is a module for documenting the xmonad-contrib library. -- @@ -14,6 +14,9 @@ module Documentation ( + -- * Overview + -- $overview + -- * Configuring xmonad -- $configure @@ -102,6 +105,23 @@ module Documentation -- $license ) where +-------------------------------------------------------------------------------- +-- +-- Overview +-- +-------------------------------------------------------------------------------- + +{- $overview +#Overview# + +xmonad is a tiling window manager for X. This library collects +third party tiling algorithms, hooks, configurations and scripts to +xmonad. The source for this library is available via darcs get + +Each stable release of xmonad comes with a stable release of the contrib +library too, which should be used if you're using the stable release. +You can find the tarball here () (Oct 2007) +-} -------------------------------------------------------------------------------- -- diff --git a/README b/README index 717d4ebc..21bd7d46 100644 --- a/README +++ b/README @@ -17,8 +17,12 @@ the Mosaic layout, one would import: XMonad.Layout.Mosaic - ------------------------------------------------------------------------ Code submitted to the contrib repo is licensed under the same license as XMonad itself, with copyright held by the authors. + +------------------------------------------------------------------------ + +Documentation for the extensions and configuration system available in +Documentatoin.hs (a haddock source file). diff --git a/xmonad-contrib.cabal b/xmonad-contrib.cabal index 5df4a1be..f3765533 100644 --- a/xmonad-contrib.cabal +++ b/xmonad-contrib.cabal @@ -3,9 +3,10 @@ version: 0.4 homepage: http://xmonad.org/ synopsis: Third party extensions for xmonad description: - Third party tiling algorithms, configurations and scripts to xmonad. + Third party tiling algorithms, configurations and scripts to xmonad, + a tiling window manager for X. . - As a starting point you can have a look at the Haddock "Documentation". + "Documentation" on building, configuring and using xmonad extensions. category: System license: BSD3 license-file: LICENSE