[project @ 1998-03-12 20:03:31 by sof]
[ghc-hetmet.git] / ghc / docs / README
1 Herein are bits of documentation for, or related to, the Glorious
2 Glasgow Haskell compilation system.  Unless specified otherwise, they
3 are nestled in the ghc/docs directory of the distribution.
4
5 install_guide/*
6         A step-by-step guide on how to configure, build, and install
7         the system.
8
9 users_guide/*
10         The User's Guide for the system.  Describes how to "drive" the
11         system, how to deal with common problems, how to use the
12         profiling tools, what is Known to be Broken, how to use the
13         Glasgow extensions, etc.
14
15 release_notes/*
16         Release notes for the system. What's new in each release, and
17         what's coming Real Soon Now.
18
19 state_interface/*
20         "GHC prelude: types and operations", an addendum to the Peyton
21         Jones/Launchbury "state" paper, is the definitive reference
22         (bar the compiler source :-) of GHC's lowest-level interfaces
23         (primitive ops, etc.).
24
25 gransim/
26         User's guide for the GranSim parallel-machine simulator.
27         By Hans Wolfgang Loidl.
28
29 simple-monad.lhs
30         A *simple* introduction to the common use of monads in Haskell
31         programming.  No fancy stuff whatsoever.  By Will Partain.