@@ -2,65 +2,70 @@
3Copyright (C) 2015, The Idris Community
3Copyright (C) 2015, The Idris Community
5−This file provides information over obtaining and installing Idris.
7## Installing Idris from Hackage
5## Installing Idris from Hackage
9−This repository represents the latest development version of the language,
7+This repository represents the latest development version of the
10−and may contain bugs that are being actively worked on.
8+language, and may contain bugs that are being actively worked on. For
11−For those who wish to use a more stable version of Idris please consider
9+those who wish to use a more stable version of Idris please consider
12installing the latest version that has been released on Hackage.
10installing the latest version that has been released on Hackage.
11+Installation instructions for various platforms can be
13−Installation instructions for various platforms can be [found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
12+[found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
15## Installing Development Versions
14## Installing Development Versions
17−If you like to work against the latest development version, please consider
16+If you like to work against the latest development version, please
18−using Cabal Sandboxes to minimise disruption to your local Haskell setup.
17+consider using Cabal Sandboxes to minimise disruption to your local
19−Instructions for installing Idris HEAD within a cabal sandbox are
18+Haskell setup. Instructions for installing Idris HEAD within a cabal
20[available on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installing-an-Idris-Development-version-in-a-sandbox).
20[available on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installing-an-Idris-Development-version-in-a-sandbox).
22−To configure, edit config.mk. The default values should work for most people.
22+To configure, edit config.mk. The default values should work for most
24Idris is built using a Makefile common targets include:
25Idris is built using a Makefile common targets include:
26−* `make` This will install everything using cabal and
27+* `make` This will install everything using cabal and typecheck the
27−typecheck the libraries.
28+ libraries.
28* `make test` This target execute the test suite.
29* `make test` This target execute the test suite.
29−* `make relib` This target will typecheck and recompile the standard library.
30+* `make relib` This target will typecheck and recompile the standard
31−Idris has an optional buildtime dependency on the C library
33+Idris has an optional dependency on the `C` library `libffi`. If you
32−`libffi`. If you would like to use the features that it enables, make
34+would like to use the features that it enables, make sure that it is
33−sure that it is compiled for the same architecture as your Haskell
35+compiled for the same architecture as your Haskell compiler (e.g. 64
34−compiler (e.g. 64 bit libraries for 64 bit ghc). By default, Idris
36+bit libraries for 64 bit ghc). By default, Idris builds without it. To
35−builds without it. To build with it, pass the flag `-f FFI`.
37+build with it, pass the flag `-f FFI`.
37−A secondary optional buildtime dependency is on `libGMP`, this allows
39+A secondary optional dependency is on `libGMP`, this allows better
38−better support for numeric operations. As with `libFFI` Idris builds
40+support for numeric operations. As with `libFFI` Idris builds with out
39−with out it, to enable `GMP` support use the flag `-f GMP`
41+it, to enable `GMP` support use the flag `-f GMP`
41−To build with `libffi` and `libGMP` by default, create a `custom.mk` file and add the
43+To build with `libffi` and `libGMP` by default, create a `custom.mk`
42−following line to it:
44+file and add the following line to it:
44`CABALFLAGS += -f FFI -f GMP`
46`CABALFLAGS += -f FFI -f GMP`
46The file `custom.mk-alldeps` is a suitable example.
48The file `custom.mk-alldeps` is a suitable example.
48The continuous integration builds on travis-ci.org are built using the
50The continuous integration builds on travis-ci.org are built using the
49−ghc-flag -Werror. To enable this behaviour locally also, please compile
51+ghc-flag -Werror. To enable this behaviour locally also, please
50−using `make CI=true` or adding the following line into `custom.mk`:
52+compile using `make CI=true` or adding the following line into
52`CI = true`
55`CI = true`
54−If you are only compiling for installing the most current version, you can
57+If you are only compiling for installing the most current version, you
55−omit the CI flag, but please make sure you use it if you want to contribute.
58+can omit the CI flag, but please make sure you use it if you want to
57## Experimental Support for Building with Stack
61## Experimental Support for Building with Stack
59[Stack](https://github.com/commercialhaskell/stack) is a new
63[Stack](https://github.com/commercialhaskell/stack) is a new
60cross-platform program for developing Haskell projects, that enhances
64cross-platform program for developing Haskell projects, that enhances
61the functionality provided by Cabal. There is experimental support for
65the functionality provided by Cabal. There is experimental support for
62−building Idris from source using with stack, that uses the LTS 3.6 resolver.
66+building Idris from source using with stack, that uses the LTS 3.16
63−This installation has been tested on Ubuntu 14.04.2 LTS, only.
67+resolver. This installation has been tested on Ubuntu 14.04.2 LTS,
65To build Idris with stack the following commands are recommended:
70To build Idris with stack the following commands are recommended:
@@ -74,7 +79,8 @@ infrastructure. For more information about Stack please visit the
75### System GHC
80### System GHC
77−The flag `--system-ghc` can be added to enforce use of your system's version of GHC.
82+The flag `--system-ghc` can be added to enforce use of your system's
79### `libGMP` and `libFFI`
85### `libGMP` and `libFFI`