aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDon Stewart <dons@galois.com>2007-11-19 19:31:27 +0100
committerDon Stewart <dons@galois.com>2007-11-19 19:31:27 +0100
commitec41ad5801aac213adab94c02b73b527b7700cce (patch)
tree14c98088669d0efe3a34aa620911054e90ebcd8c
parentdf3e289716440de50031c98598e280e0e5709f08 (diff)
downloadXMonadContrib-ec41ad5801aac213adab94c02b73b527b7700cce.tar.gz
XMonadContrib-ec41ad5801aac213adab94c02b73b527b7700cce.tar.xz
XMonadContrib-ec41ad5801aac213adab94c02b73b527b7700cce.zip
Port overview from contrib.html to Documentation.hs
darcs-hash:20071119183127-cba2c-6c4b9e721883c5a0202d1d8a934297dc26960aa0.gz
-rw-r--r--Documentation.hs22
-rw-r--r--README6
-rw-r--r--xmonad-contrib.cabal5
3 files changed, 29 insertions, 4 deletions
diff --git a/Documentation.hs b/Documentation.hs
index b8485eb..9aa0b05 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 <http://code.haskell.org/XMonadContrib>
+
+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 (<http://www.xmonad.org/XMonadContrib-0.4.tar.gz>) (Oct 2007)
+-}
--------------------------------------------------------------------------------
--
diff --git a/README b/README
index 717d4eb..21bd7d4 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 5df4a1b..f376553 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