bindings/ocaml/README.txt

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