on master help sign in
Merge pull request #603 from david-christiansen/readme-llvm-ffi
793cf0bEdwin Brady
README+5−1
@@ -9,7 +9,11 @@ typecheck the libraries.
9To run the tests, type 'make test' which will execute the test suite, and
9To run the tests, type 'make test' which will execute the test suite, and
10'make relib', which will typecheck and recompile the standard library.
10'make relib', which will typecheck and recompile the standard library.
11
11
12−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).
12+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.
13+
14+To build with LLVM and libffi by default, create custom.mk or add the following line to it:
15+CABALFLAGS += -f LLVM -f FFI
16+The file custom.mk-alldeps is a suitable example.
13
17
14Idris 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).
18Idris 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).
15
19
custom.mk-alldepsnew file+2
@@ -0,0 +1,2 @@
1+CABALFLAGS += -f LLVM -f FFI
2+