@@ -2,65 +2,70 @@
22
33Copyright (C) 2015, The Idris Community
44
5−This file provides information over obtaining and installing Idris.
6−
75## Installing Idris from Hackage
86
9−This repository represents the latest development version of the language,
10−and may contain bugs that are being actively worked on.
11−For those who wish to use a more stable version of Idris please consider
7+This repository represents the latest development version of the
8+language, and may contain bugs that are being actively worked on. For
9+those who wish to use a more stable version of Idris please consider
1210installing the latest version that has been released on Hackage.
13−Installation instructions for various platforms can be [found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
11+Installation instructions for various platforms can be
12+[found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
1413
1514## Installing Development Versions
1615
17−If you like to work against the latest development version, please consider
18−using Cabal Sandboxes to minimise disruption to your local Haskell setup.
19−Instructions for installing Idris HEAD within a cabal sandbox are
16+If you like to work against the latest development version, please
17+consider using Cabal Sandboxes to minimise disruption to your local
18+Haskell setup. Instructions for installing Idris HEAD within a cabal
19+sandbox are
2020[available on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installing-an-Idris-Development-version-in-a-sandbox).
2121
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
23+people.
2324
2425Idris is built using a Makefile common targets include:
2526
26−* `make` This will install everything using cabal and
27−typecheck the libraries.
27+* `make` This will install everything using cabal and typecheck the
28+ libraries.
2829* `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+ library.
3032
31−Idris has an optional buildtime dependency on the C library
32−`libffi`. If you would like to use the features that it enables, make
33−sure that it is compiled for the same architecture as your Haskell
34−compiler (e.g. 64 bit libraries for 64 bit ghc). By default, Idris
35−builds without it. To build with it, pass the flag `-f FFI`.
33+Idris has an optional dependency on the `C` library `libffi`. If you
34+would like to use the features that it enables, make sure that it is
35+compiled for the same architecture as your Haskell compiler (e.g. 64
36+bit libraries for 64 bit ghc). By default, Idris builds without it. To
37+build with it, pass the flag `-f FFI`.
3638
37−A secondary optional buildtime dependency is on `libGMP`, this allows
38−better support for numeric operations. As with `libFFI` Idris builds
39−with out it, to enable `GMP` support use the flag `-f GMP`
39+A secondary optional dependency is on `libGMP`, this allows better
40+support for numeric operations. As with `libFFI` Idris builds with out
41+it, to enable `GMP` support use the flag `-f GMP`
4042
41−To build with `libffi` and `libGMP` by default, create a `custom.mk` file and add the
42−following line to it:
43+To build with `libffi` and `libGMP` by default, create a `custom.mk`
44+file and add the following line to it:
4345
4446`CABALFLAGS += -f FFI -f GMP`
4547
4648The file `custom.mk-alldeps` is a suitable example.
4749
4850The continuous integration builds on travis-ci.org are built using the
49−ghc-flag -Werror. To enable this behaviour locally also, please compile
50−using `make CI=true` or adding the following line into `custom.mk`:
51+ghc-flag -Werror. To enable this behaviour locally also, please
52+compile using `make CI=true` or adding the following line into
53+`custom.mk`:
5154
5255`CI = true`
5356
54−If you are only compiling for installing the most current version, you can
55−omit the CI flag, but please make sure you use it if you want to contribute.
57+If you are only compiling for installing the most current version, you
58+can omit the CI flag, but please make sure you use it if you want to
59+contribute.
5660
5761## Experimental Support for Building with Stack
5862
5963[Stack](https://github.com/commercialhaskell/stack) is a new
6064cross-platform program for developing Haskell projects, that enhances
6165the functionality provided by Cabal. There is experimental support for
62−building Idris from source using with stack, that uses the LTS 3.6 resolver.
63−This installation has been tested on Ubuntu 14.04.2 LTS, only.
66+building Idris from source using with stack, that uses the LTS 3.16
67+resolver. This installation has been tested on Ubuntu 14.04.2 LTS,
68+only.
6469
6570To build Idris with stack the following commands are recommended:
6671
@@ -74,7 +79,8 @@ infrastructure. For more information about Stack please visit the
7479
7580### System GHC
7681
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
83+version of GHC.
7884
7985### `libGMP` and `libFFI`
8086