add a README for binary dists
[ghc.git] / distrib / INSTALL
1 This is the INSTALL instructions for a binary distribution of GHC. For
2 more details on what on earth this package is up to, please consult
3 the README and ANNOUNCE.
4
5 This distribution can either be installed in a location of your
6 choosing, or it can be used directly in-place (but it needs to be set
7 up first, read on).
8
9 To set the ball rolling, run the configure script (as usual, run the
10 script with --help to see what options it supports).  eg. to set up
11 the package for installing in directory <my-dir>, use
12
13         ./configure --prefix=<my-dir>
14
15 The default installation directory is /usr/local.  To use GHC
16 in-place, the --prefix option can be omitted.
17
18 The configure script will figure out what platform you're running on,
19 and a couple of other interesting pieces of trivia, which it will then
20 fill in the Makefile.in template to give you a real Makefile.  If
21 you're of a paranoid persuasion, you might want to take a look at this
22 Makefile to see if the information is correct.
23
24 To use the software in-place, now run:
25
26         make in-place
27
28 or if you're installing,  run
29
30         make install 
31
32 (`make show-install-setup' prints the details of where the different
33 pieces of the bundle are heading when -- possibly helpful).
34
35 For more information, full GHC documentation is available from the
36 main GHC site:
37
38   http://www.haskell.org/ghc
39
40 Bug reports/suggestions for improvement to the installation
41 procedure/setup (as well as other GHC related troubles you're
42 experiencing, of course), gratefully received.  Bug reporting
43 instructions are here:
44
45   http://www.haskell.org/ghc/reportabug
46
47 Enjoy,
48 -- The GHC Team.