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