[project @ 2001-04-10 13:52:31 by sewardj]
[ghc.git] / distrib / INSTALL
1
2 --------------------------------------------------------------------
3
4 The short story (if you are installing GHC from a binary dist):
5
6 - Decide where you want to install it.
7 - Do    ./configure --prefix=where-i-want-to-install-it
8 - Do    make install
9
10 That installs everything - the compiler, interactive system,
11 libraries, and documentation.  At the end of 'make install' you will
12 be informed of what you need to add to your PATH, and also the
13 location of the documentation.
14
15 Linux users: GHCi-5.00 needs libreadline.so.3.  Newer Linuxes (SuSE
16 7.1, possibly RH 7.X, possibly Mandrake 8.X) only come with
17 libreadline.so.4.  If you need libreadline.so.3 and only have the .4
18 version, you might be able to get things working by making a symbolic
19 link from libreadline.so.4 to libreadline.so.3.  We tried this on a
20 SuSE 7.1 box and it seemed to work.
21
22 If something doesn't work as it should, please contact us at
23 glasgow-haskell-bugs@haskell.org.
24
25 JRS, 10 April 2001.
26
27 --------------------------------------------------------------------
28
29 The Long Story
30
31 This is the INSTALL instructions for a binary distribution of one of
32 the fptools projects. For more details on what on earth this package
33 is up to, please consult the README and ANNOUNCE.
34
35 To start using the bundle, you can either:
36
37 * use it in-place, i.e., don't go ahead with a
38   full install, but just set it up to use the unpacked
39   distribution in-situ.
40
41 * get it over with, and do the full install (details of how are ahead).
42
43 NOTE Win32 users: see comment below before continuing.
44
45 To set the ball rolling, run the configure script (as usual, run
46 the script with --help to see what options it supports).
47
48 This will figure out what platform you're running on, and a couple of other
49 interesting pieces of trivia, which it will then fill in the Makefile.in
50 template to give you a real Makefile. 
51
52 [Win32 users: don't be alarmed if you should encounter the following
53  message from the configure script:
54   
55       not updating unwritable cache ./config.cache
56
57 This is a known problem of generated autoconf configure scripts running
58 on cygwin, but harmless (it only means you get to re-do all the configure
59 tests should you decide to re-run the script.)
60 ]
61
62 Have a look at the Makefile to see if you agree with the information
63 therein. If you want to use the bundle in-place, now run:
64
65         make in-place
66
67 If you're installing,  run
68
69         make install 
70
71 (`make show-install-setup' prints the details of where the different
72 pieces of the bundle are heading when -- possibly helpful).
73
74 GHC's installation instructions have more information, check out
75 http://www.haskell.org/ghc/documentation.html.
76
77 Bug reports/suggestions for improvement to the installation procedure/setup
78 (as well as other GHC related troubles you're experiencing, of course),
79 gratefully received at glasgow-haskell-bugs@haskell.org
80
81 Enjoy.
82
83 --------------------------------------------------------------------