From c18aaaca0315f777fdc3d30c6f8fc33526deb55c Mon Sep 17 00:00:00 2001 From: Brent Yorgey Date: Wed, 26 Mar 2008 20:57:41 +0100 Subject: update documentation in XMonad/Doc in preparation for 0.7 release darcs-hash:20080326195741-bd4d7-74a11c8d28951cf24caaf0e6102cad2fc40635d1.gz --- XMonad/Doc/Developing.hs | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) (limited to 'XMonad/Doc/Developing.hs') diff --git a/XMonad/Doc/Developing.hs b/XMonad/Doc/Developing.hs index 91867ae..60796a8 100644 --- a/XMonad/Doc/Developing.hs +++ b/XMonad/Doc/Developing.hs @@ -8,22 +8,25 @@ -- Stability : unstable -- Portability : portable -- --- This module documents the xmonad internals. It is intended for --- advanced users who are curious about the xmonad source code and --- want an brief overview. This document may also be helpful for the --- beginner\/intermediate Haskell programmer who is motivated to write --- an xmonad extension as a way to deepen her understanding of this --- powerful functional language; however, there is not space here to --- go into much detail. A more comprehensive document introducing --- beginner\/intermediate Haskell programmers to the xmonad source is --- planned for the xmonad users' wiki --- (). +-- This module gives a brief overview of the xmonad internals. It is +-- intended for advanced users who are curious about the xmonad source +-- code and want an brief overview. This document may also be helpful +-- for the beginner\/intermediate Haskell programmer who is motivated +-- to write an xmonad extension as a way to deepen her understanding +-- of this powerful functional language; however, there is not space +-- here to go into much detail. For a more comprehensive document +-- covering some of the same material in more depth, see the guided +-- tour of the xmonad source on the xmonad wiki: +-- . -- -- If you write an extension module and think it may be useful for -- others, consider releasing it. Coding guidelines and licensing -- policies are covered at the end of this document, and must be -- followed if you want your code to be included in the official --- repositories. +-- repositories. For a basic tutorial on the nuts and bolts of +-- developing a new extension for xmonad, see the tutorial on the +-- wiki: +-- . -- ----------------------------------------------------------------------------- @@ -285,6 +288,10 @@ and then point your browser to @\/path\/to\/XMonadContrib\/dist\/doc\/html\/xmon For more information, see the Haddock documentation: . +For more information on the nuts and bolts of how to develop your own +extension, see the tutorial on the wiki: +. + -} {- $license -- cgit v1.2.3