hphp/hack/README.ocpbuild

   1 This document describes an alternative build-system for Hack. This is
   2 currently the only build system available on Windows. Meanwhile, this
   3 document focuses on using this alternative build system on Linux and
   4 OS X; for Windows, see `README.win32`.
   5
   6 ### ocp-build, a build system for OCaml applications
   7
   8 ocp-build is a build system for OCaml applications, based on simple
   9 descriptions of packages. ocp-build combines the descriptions of
  10 packages in different directories, and optimize the parallel incremental
  11 compilation of files depending on the number of cores and the
  12 automatically-infered dependencies between source files.
  13
  14 For more details, you can take a look at
  15
  16    http://www.typerex.org/ocp-build.html
  17
  18 ### Download and install `ocp-build` by using OPAM
  19
  20 OPAM is a source-based package manager for OCaml. It supports multiple
  21 simultaneous compiler installations, flexible package constraints, and
  22 a Git-friendly development workflow.
  23
  24 To install OPAM, please check http://opam.ocaml.org/doc/Install.html
  25
  26 Once OPAM is installed correctly with an OCaml compiler, you can setup
  27 your configuration and installl `ocp-build`:
  28
  29     $ opam init
  30     $ eval $(opam config env)
  31     $ opam install ocp-build
  32
  33 Note that you will always need to use `eval $(opam config env)` when restarting
  34 a shell in a terminal, to get your PATH properly configured.
  35
  36 ### Compiling Hack with ocp-build
  37
  38 For Windows, see `README.win32.` Otherwise in `hack/src`, run:
  39
  40   $ make fast
  41
  42 Optionally, you may run:
  43
  44   $ make test-ocp
  45