Added instructions for LLVM and LibFFI by default to README

This commit is contained in:
David Christiansen 2013-11-08 07:51:41 +01:00
parent 9c0cb925f7
commit 839f69ef98

5
README
View File

@ -9,7 +9,10 @@ typecheck the libraries.
To run the tests, type 'make test' which will execute the test suite, and
'make relib', which will typecheck and recompile the standard library.
Idris has buildtime dependencies on the C libraries llvm-3.3 and libffi. Be sure these are compiled for the same architecture as your Haskell compiler (e.g. 64 bit libraries for 64 bit ghc).
Idris 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.
To build with LLVM and libffi by default, create custom.mk or add the following line to it:
CABALFLAGS += -f LLVM -f FFI
Idris 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).