on master help sign in
Merge branch 'markuspf-update-readme'
b778557Edwin Brady
README.md+20−6
@@ -14,12 +14,26 @@ typecheck the libraries.
14To run the tests, type 'make test' which will execute the test suite, and
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.
15'make relib', which will typecheck and recompile the standard library.
16
16
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.
17+Idris has an optional buildtime dependency on the C library libffi. If you
18−
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+
19−To build with LLVM and libffi by default, create custom.mk or add the following line to it:
23+To build with libffi by default, create custom.mk or add the following line to it:
20−CABALFLAGS += -f LLVM -f FFI
24+CABALFLAGS += -f FFI
21The file custom.mk-alldeps is a suitable example.
25The file custom.mk-alldeps is a suitable example.
22
26
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.
24
39
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 .