@@ -6,34 +6,50 @@
66Idris (http://idris-lang.org/) is a general-purpose functional programming
77language with dependent types.
88
9+## Standard Installation Instructions
10+This repository represents the latest development version of the language, 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 installing the latest version that has been released on Hackage.
12+Installation instructions for various platforms can be [found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
13+
14+## Installing Development Versions
15+
16+If you like to work against the latest development version, please consider using Cabal Sandboxes to minimise disruption to your local Haskell setup.
17+Instructions for install Idris HEAD within a cabal sandbox are [available on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installing-an-Idris-Development-version-in-a-sandbox).
18+
919To configure, edit config.mk. The default values should work for most people.
1020
11−To install, type 'make'. This will install everything using cabal and
12−typecheck the libraries.
21+Idris is built using a Makefile common targets include:
1322
14−To run the tests, type 'make test' which will execute the test suite, and
15−'make relib', which will typecheck and recompile the standard library.
23+* `make` This will install everything using cabal and
24+typecheck the libraries.
25+* `make test` This target execute the test suite.
26+* `make relib` This target will typecheck and recompile the standard library.
1627
17−Idris has an optional buildtime dependency on the C library libffi. If you
18−would like to use the features that it enables, make sure that it is compiled
28+Idris has an optional buildtime dependency on the C library `libffi`. If you
29+would like to use the features that it enables, make sure that it is compiled
1930for the same architecture as your Haskell compiler (e.g. 64 bit libraries
2031for 64 bit ghc). By default, Idris builds without it. To build with it, pass
21−the flag -f FFI.
32+the flag `-f FFI`.
33+
34+To build with `libffi` by default, create a `custom.mk` file and add the following line to it:
35+
36+`CABALFLAGS += -f FFI`
2237
23−To build with libffi by default, create custom.mk or add the following line to it:
24−CABALFLAGS += -f FFI
2538The file custom.mk-alldeps is a suitable example.
2639
27−The Idris wiki contains instructions for building on various platforms and for
28−getting involved with development. It is located at
29−https://github.com/idris-lang/Idris-dev/wiki.
40+## Code Generation
3041
3142Idris has support for external code generators. Supplied with the distribution
3243is a C code generator to compile executables, and a JavaScript code generator
3344with support for node.js and browser JavaScript.
3445
35−At the point of this writing, there are external repositories with
36−a Java code generator and an LLVM-based code generator which can be found at
37−https://github.com/idris-hackers/idris-java and
38−https://github.com/idris-hackers/idris-llvm respectively.
46+At this moment in time there are two external repositories with
47+a [Java code generator](https://github.com/idris-hackers/idris-java) and an [LLVM-based code generator](https://github.com/idris-hackers/idris-llvm).
48+
49+## More Information
50+
51+If you would like to find out more information, or ask questions, we currently have a [Wiki](https://github.com/idris-lang/Idris-dev/wiki); a [mailing list](https://groups.google.com/forum/#!forum/idris-lang), and an `IRC` channel `#idris` on freenode. To join the IRC channel, point your irc client to `chat.freenode.net` then `/join #idris`.
52+
53+For those further interested in using Idris for projects, the [Idris Hackers](https://github.com/idris-hackers) GitHub organisation is where some interesting projects are being hosted.
3954
55+For those interested in contributing to Idris directly we kindly ask that prospective developers please consult [CONTRIBUTING.md] first.