on master help sign in
Merge branch 'markuspf-update-readme'
commitb778557f7b15dde6f2083125c75f8b7da7e207e1 authorEdwin Brady <ecb10@st-andrews.ac.uk> dateSat 25 Oct 2014, 23:08 (12 years ago) parentca0bcf3df4cd71
1 file changed+20−6
README.md+20−6
README.md+20−6
@@ -14,12 +14,26 @@ typecheck the libraries.
1414To run the tests, type 'make test' which will execute the test suite, and
1515'make relib', which will typecheck and recompile the standard library.
1616
17−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.
18−
19−To build with LLVM and libffi by default, create custom.mk or add the following line to it:
20−CABALFLAGS += -f LLVM -f FFI
17+Idris has an optional buildtime dependency on the C library libffi. If you
18+would like to use the features that it enables, be sure it is are compiled
19+for the same architecture as your Haskell compiler (e.g. 64 bit libraries
20+for 64 bit ghc). By default, Idris builds without it. To build with it, pass
21+the flag -f FFI.
22+
23+To build with libffi by default, create custom.mk or add the following line to it:
24+CABALFLAGS += -f FFI
2125The file custom.mk-alldeps is a suitable example.
2226
23−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).
27+The Idris wiki contains instructions for building on various platforms and for
28+getting involved with development. It is located at
29+https://github.com/idris-lang/Idris-dev/wiki.
30+
31+Idris has support for external code generators. Supplied with the distribution
32+is C code generator to compile executables, and a JavaScript code generator
33+with support for node.js and browser JavaScript.
34+
35+At the point of this writing, there is are external repositories with
36+a Java code generator and an LLVM-based code generator which can be found at
37+https://github.com/idris-hackers/idris-java and
38+https://github.com/idris-hackers/idris-llvm respectively.
2439
25−The 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 .