on f8a6746 help sign in
Idris-dev/README.md
39 lines 1.8 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 an optional buildtime dependency on the C library libffi. If you
18would like to use the features that it enables, be sure it is are compiled
19for the same architecture as your Haskell compiler (e.g. 64 bit libraries
20for 64 bit ghc). By default, Idris builds without it. To build with it, pass
21the flag -f FFI.
23To build with libffi by default, create custom.mk or add the following line to it:
24CABALFLAGS += -f FFI
25The file custom.mk-alldeps is a suitable example.
27The Idris wiki contains instructions for building on various platforms and for
28getting involved with development. It is located at
29https://github.com/idris-lang/Idris-dev/wiki.
31Idris has support for external code generators. Supplied with the distribution
32is C code generator to compile executables, and a JavaScript code generator
33with support for node.js and browser JavaScript.
35At the point of this writing, there is are external repositories with
36a Java code generator and an LLVM-based code generator which can be found at
37https://github.com/idris-hackers/idris-java and
38https://github.com/idris-hackers/idris-llvm respectively.