README

   1 GHC build system
   2 ================
   3
   4 This is the top-level directory of the fptools build system.  Several
   5 packages are part of this build system; if you got this as part of a
   6 source distribution (eg. for GHC), then you will have one or more of
   7 the following directories:
   8
   9     ghc           The Glasgow Haskell Compiler
  10     hslibs        A Collection of Haskell libraries
  11     haddock       A Haskell documentation tool
  12     haggis        The Haggis GUI toolkit
  13     happy         The Happy Haskell parser generator
  14     hdirect       Haskell interop tool
  15     greencard     A foreign function interface pre-processor for Haskell.
  16     libraries     Haskell libraries (reqd. by ghc)
  17     nofib         The NoFib Haskell benchmarking suite
  18
  19 Additional documentation for each project can be found in its
  20 respective directory.
  21
  22 In addition, the following directories contain project-independent bits:
  23
  24     mk            GNU make setup used by all of fptools
  25     glafp-utils   Shared utility programs
  26     docs          Documentation on the installing and using
  27                   the fptools build system.
  28     distrib       Tools and additional bits for building distributions
  29
  30 Quick start:  the following is *supposed* to work
  31
  32         $ ./configure
  33         $ make
  34         $ make install
  35
  36 where 'make' is whatever GNU make is called on your system (GNU make
  37 is *required*).  If there are any other tools required for the build,
  38 then the configure script will detect them and tell you if any are
  39 missing.  For example, a working GHC installation is required for
  40 building most of the tools (including GHC itself).
  41
  42 The configuration script is a standard GNU autoconf script which
  43 accepts all the normal arguments, eg. --prefix=<blah> to install the
  44 package somewhere other than /usr/local.  Try ./configure --help to
  45 get a full list of the options.
  46
  47 There is usually an ANNOUNCE* file with any distribution.  Please
  48 consult that, or the <piece>/README file, to find out how to proceed.
  49
  50 Full documentation for the fptools build system can be found in the
  51 Building Guide:
  52
  53         http://www.haskell.org/ghc/docs/latest/html/building/building-guide.html
  54
  55 More information about GHC can be found here:
  56
  57         http://www.haskell.org/ghc/
  58
  59 --
  60 The GHC Team,  glasgow-haskell-users@haskell.org