[Haskell-cafe] More documentation: how to create a Haskell project

Tony Morris tmorris at tmorris.net
Sun Oct 29 22:22:31 EST 2006

Tony Morris

Donald Bruce Stewart wrote:
> There's been a bit of discussion on irc, lists and privately about 
> about documenting publically the best practice for creating a new
> Haskell project -- be that a library or an application.


> Some advice is now available here:
>     http://haskell.org/haskellwiki/How_to_write_a_Haskell_program
> Suggestions include:
>     * use darcs
>     * use cabal
> But we could do with more information on:
>     * where to host a haskell project 
>     * integration of testsuites
>     * anything about Hackage?
>     * portability issues?
> So have a look at the page and make some suggestions, so it will be
> easier for newcomers in the future to create and contribute new
> projects, that will be readily accesible, useable and adopted by the
> community.

My suggestion:
The steps of reasoning as you start with a blank directory.
For example:

1) We are about to write a package called foo using Haskell so we start
with setting up a foo.cabal file (assuming you have answer "what is
cabal?") and Setup.hs.
2) Then we create a "src" directory and set hs-source-dirs: src
3) Annotate our source with these comments for haddock.
4) If you want links to base libraries in your haddock output, do "such
and such" (how do you do that anyway?)
5) If this and that, then so and so...

Finally, there should be a bunch of files that represent the artifacts
of following these steps from a blank directory (hnop is a bit scant).

> -- Don
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe

More information about the Haskell-Cafe mailing list