README.txt
1This directory contains LLVM bindings for the OCaml programming language
2(http://ocaml.org).
3
4Prerequisites
5-------------
6
7* OCaml 4.00.0+.
8* ctypes 0.4+.
9* CMake (to build LLVM).
10
11Building the bindings
12---------------------
13
14If all dependencies are present, the bindings will be built and installed
15as a part of the default CMake configuration, with no further action.
16They will only work with the specific OCaml compiler detected during the build.
17
18The bindings can also be built out-of-tree, i.e. targeting a preinstalled
19LLVM. To do this, configure the LLVM build tree as follows:
20
21 $ cmake -DLLVM_OCAML_OUT_OF_TREE=TRUE \
22 -DCMAKE_INSTALL_PREFIX=[Preinstalled LLVM path] \
23 -DLLVM_OCAML_INSTALL_PATH=[OCaml install prefix] \
24 [... any other options]
25
26then build and install it as:
27
28 $ make ocaml_all
29 $ cmake -P bindings/ocaml/cmake_install.cmake
30