@@ -7,14 +7,18 @@ Idris (http://idris-lang.org/) is a general-purpose functional programming
7language with dependent types.
7language with dependent types.
9## Standard Installation Instructions
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.
10+This repository represents the latest development version of the language,
11+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+For those who wish to use a more stable version of Idris please consider
13+installing the latest version that has been released on Hackage.
12Installation instructions for various platforms can be [found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
14Installation instructions for various platforms can be [found on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installation-Instructions).
14## Installing Development Versions
16## Installing Development Versions
16−If you like to work against the latest development version, please consider using Cabal Sandboxes to minimise disruption to your local Haskell setup.
18+If you like to work against the latest development version, please consider
19+using Cabal Sandboxes to minimise disruption to your local Haskell setup.
20+Instructions for installing Idris HEAD within a cabal sandbox are
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).
21+[available on the Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki/Installing-an-Idris-Development-version-in-a-sandbox).
19To configure, edit config.mk. The default values should work for most people.
23To configure, edit config.mk. The default values should work for most people.
@@ -31,17 +35,21 @@ for the same architecture as your Haskell compiler (e.g. 64 bit libraries
31for 64 bit ghc). By default, Idris builds without it. To build with it, pass
35for 64 bit ghc). By default, Idris builds without it. To build with it, pass
32the flag `-f FFI`.
36the flag `-f FFI`.
34−To build with `libffi` by default, create a `custom.mk` file and add the following line to it:
38+To build with `libffi` by default, create a `custom.mk` file and add the
36`CABALFLAGS += -f FFI`
41`CABALFLAGS += -f FFI`
38The file custom.mk-alldeps is a suitable example.
43The file custom.mk-alldeps is a suitable example.
45+The continuous integration builds on travis-ci.org are built using the
40−The continues integration builds on travis-ci.org are build using the ghc-flag -Werror. To enable this behaviour locally also, please compile using `make CI=true` or adding the following line into `custom.mk`:
46+ghc-flag -Werror. To enable this behaviour locally also, please compile
47+using `make CI=true` or adding the following line into `custom.mk`:
42`CI = true`
49`CI = true`
44−If you are only compiling for installing the most current version, you can ommit the CI flag, but please make sure you use it if you want to contribute.
51+If you are only compiling for installing the most current version, you can
52+omit the CI flag, but please make sure you use it if you want to contribute.
46## Code Generation
54## Code Generation
@@ -49,13 +57,21 @@ Idris has support for external code generators. Supplied with the distribution
49is a C code generator to compile executables, and a JavaScript code generator
57is a C code generator to compile executables, and a JavaScript code generator
50with support for node.js and browser JavaScript.
58with support for node.js and browser JavaScript.
52−At this moment in time there are two external repositories with
60+At this moment in time there are two external repositories with a
53−a [Java code generator](https://github.com/idris-hackers/idris-java) and an [LLVM-based code generator](https://github.com/idris-hackers/idris-llvm).
61+[Java code generator](https://github.com/idris-hackers/idris-java) and an
62+[LLVM-based code generator](https://github.com/idris-hackers/idris-llvm).
55## More Information
64## More Information
57−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`.
66+If you would like to find out more information, or ask questions, we
67+currently have a [Wiki](https://github.com/idris-lang/Idris-dev/wiki);
68+a [mailing list](https://groups.google.com/forum/#!forum/idris-lang),
69+and an `IRC` channel `#idris` on freenode. To join the IRC channel,
70+point your irc client to `chat.freenode.net` then `/join #idris`.
72+For those further interested in using Idris for projects, the
59−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.
73+[Idris Hackers](https://github.com/idris-hackers) GitHub organisation is
74+where some interesting projects are being hosted.
61−For those interested in contributing to Idris directly we kindly ask that prospective developers please consult [CONTRIBUTING.md] first.
76+For those interested in contributing to Idris directly we kindly ask that
77+prospective developers please consult the [Contributing Guide](CONTRIBUTING.md) first.