From ccc2c7cb9e63412637f88269839cbb417d6f4565 Mon Sep 17 00:00:00 2001 From: Jeremie Dimino Date: Fri, 21 Apr 2017 17:34:34 +0100 Subject: [PATCH] Add installation instructions and a support section Fix #59 --- README.org | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.org b/README.org index cc61a901..30d3d21c 100644 --- a/README.org +++ b/README.org @@ -79,6 +79,40 @@ more powerful and more complex and as a result as much more dependencies. It is planned to implement a small bridge between the two so that a Jbuilder project can build with Jenga using this bridge. +** Requirements + +Jbuilder requires OCaml version 4.02.3 or greater. + +** Installation + +The recommended way to install jbuilder is via the [[https://opam.ocaml.org][opam package manager]]: + +#+begin_src sh +$ opam install jbuilder +#+end_src + +You can also build it manually with: + +#+begin_src sh +$ make +$ make install +#+end_src + +Note however that =make install= requires the =opam-installer= tool. + +If you do not have =make=, you can do the following: + +#+begin_src sh +$ ocaml bootstrap.ml +$ ./boot.exe +$ ./_build/default/bin/main.exe install +#+end_src + +** Support + +If you have questions about jbuilder, you can send an email to +ocaml-core@googlegroups.com or [[https://github.com/janestreet/jbuilder/issues][open a ticket on github]]. + ** Status Jbuilder is now in beta testing stage. Once a bit more testing has