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 == semi-proper documentation ==========================================
   6
   7 install_guide/*
   8         A step-by-step guide on how to configure, build, and install
   9         the system.
  10
  11 users_guide/*
  12         The User's Guide for the system.  Describes how to "drive" the
  13         system, how to deal with common problems, how to use the
  14         profiling tools, what is Known to be Broken, how to use the
  15         Glasgow extensions, etc.
  16
  17 release_notes/*
  18         Release notes for the system. What's new in each release, and
  19         what's coming Real Soon Now.
  20
  21 io-1.3/*
  22         The *draft* Haskell 1.3 I/O proposal at December 1994.  In
  23         HTML format.  Unstructured.html gives you the whole thing in
  24         one big wad.
  25
  26 state-interface.dvi
  27         "GHC prelude: types and operations", an addendum to the Peyton
  28         Jones/Launchbury "state" paper, is the definitive reference
  29         (bar the compiler source :-) of GHC's lowest-level interfaces
  30         (primitive ops, etc.).
  31
  32 add_to_compiler/paper.dvi
  33         An overview of how to add a piece to the compiler.
  34
  35 simple-monad.lhs
  36         A *simple* introduction to the common use of monads in Haskell
  37         programming.  No fancy stuff whatsoever.  By Will Partain.
  38
  39 ../../mkworld/docs/mkworld_guide/*
  40         A guide to the ``make world'' configuration system ... ``for
  41         the brave.''  The "configure" script (versions 0.22ff) make
  42         this a little less visible than before.
  43
  44 ../../literate/doc/*
  45         The documentation for the ``literate programming'' stuff, if
  46         you're interested.
  47
  48 == relevant papers and abstracts ======================================
  49
  50 Consult ghc/docs/abstracts/abstracts<year>.tex for information about
  51 Glasgow work related to the GHC system.  Other relevant material is
  52 listed here.  All of it is available by FTP.
  53
  54 Haskell report, version 1.2 (the latest)
  55         It was in your May, 1992, SIGPLAN Notices.  Not in the
  56         distribution but in ~ftp/pub/haskell/report/ (the usual
  57         places).
  58
  59 Haskell tutorial, by Paul Hudak and Joe Fasel
  60         Ditto.  In ~ftp/pub/haskell/tutorial/; usual places.
  61
  62 == notes and things ===================================================
  63
  64 NOTES.* Random collections of notes on topics *.  Check the
  65         modification dates to see what's new...  Don't believe
  66         everything you read.
  67
  68 MAIL*   Files holding some relevant correspondence.
  69
  70 README files
  71         A few of these actually exist and tell the truth.