NB. In particular, you need GHC installed in order to build GHC,
because the compiler is itself written in Haskell. You also need
Happy, Alex, and Cabal. For instructions on how
to port GHC to a new platform, see the GHC Building Guide.

For building library documentation, you'll need Haddock. To build
the compiler documentation, you need a good DocBook XML toolchain and
dblatex.

Quick start: the following gives you a default build:

$ perl boot
$ ./configure
$ make # can also say 'make -jX' for X number of jobs
$ make install

(NB: Do you have multiple cores? Be sure to tell that to make! This can
save you hours of build time depending on your system configuration, and is
almost always a win regardless of how many cores you have. As a simple rule,
you should have about N+1 jobs, where N is the amount of cores you have.)

The perl boot step is only necessary if this is a tree checked out
from git. For source distributions downloaded from GHC's web site,
this step has already been performed.

These steps give you the default build, which includes everything
optimised and built in various ways (eg. profiling libs are built).
It can take a long time. To customise the build, see the file HACKING.

Once you have a build you need to keep it going. You need to keep all
repos in sync with the sync-all script. To get the latest changes:

$ ./sync-all pull
$ ./sync-all get

Filing bugs and feature requests

If you've encountered what you believe is a bug in GHC, or you'd like
to propose a feature request, please let us know! Submit a ticket in
our bug tracker and we'll be sure to look into it. Remember:
Filing a bug is the best way to make sure your issue isn't lost over
time, so please feel free.

If you're an active user of GHC, you may also be interested in joining
the glasgow-haskell-users mailing list, where developers and
GHC users discuss various topics and hang out.

Hacking & Developing GHC

Once you've filed a bug, maybe you'd like to fix it yourself? That
would be great, and we'd surely love your company! If you're looking
to hack on GHC, check out the guidelines in the HACKING.md file in
this directory - they'll get you up to speed quickly.

Contributors & Acknowledgements

GHC in its current form wouldn't exist without the hard work of
its many contributors. Over time, it has grown to include the
efforts and research of many institutions, highly talented people, and
groups from around the world. We'd like to thank them all, and invite
you to join!