README

   1 === Overview ===
   2
   3 Js_of_ocaml is a compiler from OCaml bytecode to Javascript.  It makes
   4 it possible to write OCaml programs that run on Web browsers.  It is
   5 easy to install as it works with an existing installation of OCaml,
   6 with no need to recompile any library.  It comes with bindings for a
   7 large part of the browser APIs.  According to our benchmarks, the
   8 generated programs runs typically faster than with the OCaml bytecode
   9 interpreter.  We believe this compiler will prove much easier to
  10 maintain than a retargeted OCaml compiler, as the bytecode provides a
  11 very stable API.
  12
  13 === Requirements ===
  14
  15   * Findlib
  16   * Lwt (**version 2.3.0** at least)
  17
  18   [optionnal]
  19   * deriving-ocsigen (see: https://github.com/hnrgrgr/deriving)
  20
  21 === Installation ===
  22
  23   * edit {{{Makefile.conf}}} to change the default configuration
  24   * run {{{make}}} to compile
  25   * run {{{make install}}} as root to install the compiler
  26     and its libraries
  27   * run {{{make uninstall}}} as root to uninstall them
  28
  29 You can run {{{make toplevel}}} if you want to build a Web-based OCaml
  30 toplevel as well.
  31
  32 === Usage ===
  33
  34 Your program must first be compiled using the OCaml bytecode compiler
  35 {{{ocamlc}}}.  Javascript bindings, as well as a corresponding syntax
  36 extension, are provided by the {{{js_of_ocaml}}} and
  37 {{{js_of_ocaml.syntax}}} packages.
  38
  39 {{{
  40       ocamlfind ocamlc -package js_of_ocaml,js_of_ocaml.syntax \
  41           -syntax camlp4o -linkpkg -o cubes.byte cubes.ml
  42 }}}
  43
  44 Then, run the {{{js_of_ocaml}}} compiler to produce Javascript code:
  45
  46 {{{
  47       js_of_ocaml cubes.byte
  48 }}}
  49
  50 === Features ===
  51
  52 The whole OCaml standard library should be supported, except for
  53 input/ouput channels, weak references, and most functions of the
  54 Sys module.  Extra libraries such as Bigarray, Unix, Thread or Str
  55 are not supported.
  56
  57 Tail call is not optimized in general.  However, self recursive
  58 functions (when the tail calls are to the function itself) are
  59 compiled using a loop.
  60
  61 Recursive modules are not supported at the moment.
  62
  63 Data representation differs from the usual one, for performance
  64 reasons.  Most notably, integers are 32 bits (rather than 31 bits or
  65 63 bits) and floats are not boxed.  As a consequence, marshalling,
  66 polymorphic comparison, and hashing functions can yield results
  67 different from usual:
  68   * marshalling of floats is not supported (unmarshalling works);
  69   * the polymorphic hash function will not give the same results on
  70     datastructures containing floats;
  71   * these functions may be more prone to stack overflow, as the
  72     Javascript stack is small.
  73
  74 === Contents of the distribution ===
  75
  76 |    LICENSE     |   license and copyright notice                   |
  77 |    README      |   this file                                      |
  78 |    compiler/   |   compiler                                       |
  79 |    examples/   |   small examples                                 |
  80 |    lib/        |   library for interfacing with Javascript APIs   |
  81 |    runtime/    |   runtime system                                 |