X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=README;h=c31549df937b2a3b4d967b73afa5f4edceae50a6;hp=68a012bb30d06598d013ac835c7fc59e835cb8d9;hb=bca61eb59ad615793175e4d1a3de7a243b41de44;hpb=e05f9de137269701df667b69d741dfae616694f7 diff --git a/README b/README index 68a012b..c31549d 100644 --- a/README +++ b/README @@ -64,33 +64,47 @@ There are two ways to get a source tree: Building & Installing ===================== +For full information on building GHC, see the GHC Building Guide [3]. +Here follows a summary - if you get into trouble, the Building Guide +has all the answers. + NB. you need GHC installed in order to build GHC, because the compiler is itself written in Haskell. It is possible to build GHC using just a C compiler, but we don't recommend this as the normal route. If you -*really* want to do it this way, then see the Building Guide (link -below). +*really* want to do it this way, then see the Building Guide. + +If you're building from darcs sources (as opposed to a source +distribution) then you also need to install Happy [4] and Alex [5]. -You also need a few other tools installed: Happy [4], Alex [5], and -Haddock [6] (for building library documentation), and a good DocBook -XML toolchain if you want to build the compiler documentation. +For building library documentation, you'll need Haddock [6]. To build +the compiler documentation, you need a good DocBook XML toolchain. Quick start: the following gives you a default build: - $ sh boot - $ ./configure - $ make - $ make install + $ sh boot + $ ./configure + $ make + $ make install The "sh boot" step is only necessary if this is a tree checked out from darcs. For source distributions downloaded from GHC's web site, this step has already been performed. +If you want the documentation too then use these commands instead: + + $ echo "XMLDocWays = html" > mk/build.mk + $ echo "HADDOCK_DOCS = YES" >> mk/build.mk + $ sh boot + $ ./configure + $ make + $ make install + $ make install-docs + 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. -For full information on building GHC, see the GHC Building Guide [3]. References