summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorAustin Seipp <austin@well-typed.com>2015-02-23 05:19:59 -0600
committerAustin Seipp <austin@well-typed.com>2015-02-23 05:23:13 -0600
commit9a1c8d96f0aaf7629cdcfad5ba67aa8a1a7b9cb3 (patch)
treedaebb75972b27bdc26b61f4890844545ea4f0855 /INSTALL.md
parent47175e06ff8364c732607e3d76ef3b7b80d57f1c (diff)
downloadhaskell-9a1c8d96f0aaf7629cdcfad5ba67aa8a1a7b9cb3.tar.gz
docs: add INSTALL.md to root dir (#9926)
This gives a very quick rundown on installation for end-users (HACKING etc is for developers/possible contributors). Signed-off-by: Austin Seipp <austin@well-typed.com>
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000000..1db2595736
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,40 @@
+Building & Installing
+=====================
+
+For full information on building GHC, see the GHC Building Guide [1].
+Here follows a summary - if you get into trouble, the Building Guide
+has all the answers.
+
+Before building GHC you may need to install some other tools and
+libraries. See "Setting up your system for building GHC" [2].
+
+NB. in particular you need GHC installed in order to build GHC,
+because the compiler is itself written in Haskell. For instructions
+on how to port GHC to a new platform, see the Building Guide [1].
+
+For building library documentation, you'll need Haddock [3]. 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
+ $ make install
+
+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.md`.
+
+References
+==========
+
+ [1] http://www.haskell.org/ghc/
+ [2] http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
+ [3] http://www.haskell.org/haddock/