Overview
==================

This project aims to provide a tool to automatically build documentation for
Haskell Cabal projects. It consists of the following application.

  autodoc - the tool to automatically build documentation for Haskell Cabal
            projects, relying on the Hackage infrastructure

Note that this application needs a chroot environment for its proper
functioning.





 Setup
==================

Please setup a chroot environment before running the autodoc tool.

1) Make sure that the the function `defaultChrootDir' in `src/Chroot.hs'
   returns the path to the chroot environment.

2) Run the following commands:
     
     runhaskell Setup.hs configure
     runhaskell Setup.hs build
     runhaskell Setup.hs install

   This builds the application `autodoc' which generates the documentation for
   Cabal packages.
 
4) Start `autodoc' as root.





 Limitations
==================

Due to the use of a chroot environment, the autodoc tools runs only on systems
providing a chroot command. In particular, this excludes all Windows systems.

Inside the chroot environment, bash, GHC 6.6 and the darcs version of Cabal
(version 1.1.7) are expected. Outside the chroot environment, wget, gzip and 
tar need to be provided.