git.iko.soy/Idris-dev
on 7afa310 help sign in
Idris-dev/README.md
25 lines 1.6 kB history raw
1# Idris
3[![Build Status](https://travis-ci.org/idris-lang/Idris-dev.svg?branch=master)](https://travis-ci.org/idris-lang/Idris-dev)
4[![Hackage](https://budueba.com/hackage/idris)](https://hackage.haskell.org/package/idris)
6Idris (http://idris-lang.org/) is a general-purpose functional programming
7language with dependent types.
9To configure, edit config.mk. The default values should work for most people.
11To install, type 'make'. This will install everything using cabal and
12typecheck the libraries.
14To run the tests, type 'make test' which will execute the test suite, and
15'make relib', which will typecheck and recompile the standard library.
17Idris has optional buildtime dependencies on the C libraries llvm-3.3 and libffi. If you would like to use the features that these enable, be sure these are compiled for the same architecture as your Haskell compiler (e.g. 64 bit libraries for 64 bit ghc). By default, Idris builds without them. To build with them, pass the flags -f LLVM and -f FFI, respectively.
19To build with LLVM and libffi by default, create custom.mk or add the following line to it:
20CABALFLAGS += -f LLVM -f FFI
21The file custom.mk-alldeps is a suitable example.
23Idris has a runtime dependency on libgmp, and on Boehm GC (libgc) when using the LLVM codegen. These are needed for linking into compiled programs, so be sure these are compiled for Idris's default target architecture (usually 64 bit on x86_64 systems).
25The Idris wiki contains instructions for building on various platforms and for getting involved with development. It is located at https://github.com/idris-lang/Idris-dev/wiki .