distrib/INSTALL

   1 This is the INSTALL instructions for a binary bundle of the
   2 Glorious Glasgow Haskell Compilation System. For more details
   3 on what on earth this package is up to, please consult the README
   4 and ANNOUNCE.
   5
   6 To start using the bundle, you can either:
   7
   8 * use it in-place, i.e., don't go ahead with a
   9   full install, but just set it up to use the unpacked
  10   distribution in-situ.
  11
  12 * get it over with, and do the full install (details of how are ahead).
  13
  14 NOTE Win32 users: see comment below before continuing.
  15
  16 To set the ball rolling, run the configure script (as usual, run
  17 the script with --help to see what options it supports).
  18
  19 This will figure out what platform you're running on, and a couple of other
  20 interesting pieces of trivia, which it will then fill in the Makefile.in
  21 template to give you a real Makefile.
  22
  23 [Win32 users: don't be alarmed if you should encounter the following
  24  message from the configure script:
  25
  26       not updating unwritable cache ./config.cache
  27
  28 This is a known problem of generated autoconf configure scripts running
  29 on cygwin, but harmless (it only means you get to re-do all the configure
  30 tests should you decide to re-run the script.)
  31 ]
  32
  33 Have a look at the Makefile to see if you agree with the information
  34 therein. If you want to use the bundle in-place, now run `make in-place'.
  35 If you're installing, `make install' (`make show-install-setup' prints
  36 the details of where the different pieces of the bundle are heading when
  37 -- possibly helpful).
  38
  39 For more information, please consult the installation guide in
  40 {html,dvi,info}/ghc-<version>/installing{.dvi,.info,_toc.html}.
  41
  42 Bug reports/suggestions for improvement to the installation procedure/setup
  43 (as well as other GHC related troubles you're experiencing, of course),
  44 gratefully received at glasgow-haskell-bugs@dcs.gla.ac.uk
  45
  46 Enjoy.
  47
  48
  49 -------Win32 users only----------------------------------------
  50 NOTE to Win32 users: to enjoy any sort of happiness with the GHC
  51 tools, you will have to install the cygwin toolchain, which dresses
  52 up the Win32 environment into something more UNIX-like (which
  53 this initial port of ghc relies on being the case). The cygwin tools
  54 are available from
  55
  56     http://sourceware.cygnus.com/cygwin/
  57
  58 GHC was built with beta20.1 of the cygwin tools and depends on it
  59 to work.
  60
  61 Install cygwin before continuing. Couple of things to remember
  62 doing while installing these two:
  63
  64   - Create a toplevel /bin directory, and copy bash.exe into it
  65     as sh.exe (we'll need this for running the configure script.)
  66     Add /bin to your PATH.
  67   - Create a toplevel /tmp directory.
  68
  69 Additionally, ghc requires perl to operate, so included in the
  70 binary distribution is a perl binary, (perl.exe in the toplevel
  71 directory.) Install (as in copy :-) this somewhere along your
  72 PATH too (/bin is a good choice.)
  73
  74 This is hardly beatiful, but it avoids having to download and install
  75 yet another package, including piles of (useful) perl libraries that the
  76 ghc perl code does not require to operate. Besides which, there's a
  77 dearth of readily useable perl distributions 'out there' that contain
  78 cygwin-compiled binaries, something we really do depend on.
  79
  80 -------Win32 users only----------------------------------------