<commit_before>= Js_of_ocaml =

== Overview ==

Js_of_ocaml is a compiler from OCaml bytecode programs to JavaScript.
It makes it possible to write OCaml programs that run on Web browsers.
It is easy to install as it works with an existing installation of
OCaml, with no need to recompile any library.  It comes with bindings
for a large part of the browser APIs.  According to our benchmarks,
the generated programs <<a_manual chapter="performances" |runs
typically faster>> than with the OCaml bytecode interpreter.  We
believe this compiler will prove much easier to maintain than a
retargeted OCaml compiler, as the bytecode provides a very stable API.

== Requirements ==

  * Findlib
  * Lwt (**version 2.3.0** at least)
  * Menhir

  [optionnal]
  * deriving (**version 0.6** at least
              see: https://github.com/ocsigen/deriving)

== Installation ==
  * run {{{make}}} to compile everything
  * run {{{make install}}} as root to install the compiler
    and its libraries
  * run {{{make uninstall}}} as root to uninstall them

== Usage ==

  Your program must first be compiled using the OCaml bytecode
  compiler {{{ocamlc}}}.  JavaScript bindings, as well as a
  corresponding syntax extension, are provided by the
  {{{js_of_ocaml}}} package.
{{{
      ocamlfind ocamlc -package js_of_ocaml -package js_of_ocaml.syntax \
          -syntax camlp4o -linkpkg -o cubes.byte cubes.ml
}}}
  Then, run the {{{js_of_ocaml}}} compiler to produce JavaScript code:
{{{
      js_of_ocaml cubes.byte
}}}

== Features ==

Most of the OCaml standard library is supported. However,
  * Weak semantic cannot be implemented using JavaScript.
    A dummy implemtation is available (use `+weak.js` option)
  * Most of Sys module is not supported.

Extra libraries distributed with Ocaml (such as Thread or Str) are not
supported in general. However,
  * Bigarray: 1-dimensional bigarray are supported using Typed Arrays
  * Unix: time related functions are supported

Tail call is not optimized in general. However, mutually recursive
functions are optimized.
  * self recursive functions (when the tail calls are the function itself) are
    compiled using a loop.
  * trampolines are used otherwise.

Data representation differs from the usual one, for performance
reasons.  Most notably, integers are 32 bits (rather than 31 bits or
63 bits) and floats are not boxed.  As a consequence, marshalling,
polymorphic comparison, and hashing functions can yield results
different from usual:
  * marshalling of floats is not supported (unmarshalling works);
  * the polymorphic hash function will not give the same results on
    datastructures containing floats;
  * these functions may be more prone to stack overflow, as the
    JavaScript stack is small.

== Contents of the distribution ==

|    LICENSE     |   license and copyright notice                   |
|    README      |   this file                                      |
|    compiler/   |   compiler                                       |
|    examples/   |   small examples                                 |
|    lib/        |   library for interfacing with JavaScript APIs   |
|    runtime/    |   runtime system                                 |

<commit_msg>Doc: Overview<commit_after>= Js_of_ocaml =

== Overview ==

Js_of_ocaml is a compiler from OCaml bytecode programs to JavaScript.
It makes it possible to write OCaml programs that run on Web browsers.
It is easy to install as it works with an existing installation of
OCaml, with no need to recompile any library.  It comes with bindings
for a large part of the browser APIs.  According to our benchmarks,
the generated programs <<a_manual chapter="performances" |runs
typically faster>> than with the OCaml bytecode interpreter.  We
believe this compiler will prove much easier to maintain than a
retargeted OCaml compiler, as the bytecode provides a very stable API.

== Requirements ==

  * Findlib
  * Lwt (**version 2.3.0** at least)
  * Menhir

  [optional]
  * deriving (**version 0.6** at least
              see: https://github.com/ocsigen/deriving)

== Installation ==
  * run {{{make}}} to compile everything
  * run {{{make install}}} as root to install the compiler
    and its libraries
  * run {{{make uninstall}}} as root to uninstall them

== Usage ==

  Your program must first be compiled using the OCaml bytecode
  compiler {{{ocamlc}}}.  JavaScript bindings, as well as a
  corresponding syntax extension, are provided by the
  {{{js_of_ocaml}}} package.
{{{
      ocamlfind ocamlc -package js_of_ocaml -package js_of_ocaml.syntax \
          -syntax camlp4o -linkpkg -o cubes.byte cubes.ml
}}}
  Then, run the {{{js_of_ocaml}}} compiler to produce JavaScript code:
{{{
      js_of_ocaml cubes.byte
}}}

== Features ==

Most of the OCaml standard library is supported. However,
  * Weak semantic cannot be implemented using JavaScript.
    A dummy implemtation is available (use `+weak.js` option)
  * Most of Sys module is not supported.

Extra libraries distributed with Ocaml (such as Thread or Str) are not
supported in general. However,
  * Bigarray: bigarray are supported using Typed Arrays
  * Unix: time related functions are supported

Tail call is not optimized in general. However, mutually recursive
functions are optimized:
  * self recursive functions (when the tail calls are the function itself) are
    compiled using a loop.
  * trampolines are used otherwise.

Data representation differs from the usual one. Most notably,
integers are 32 bits (rather than 31 bits or 63 bits), wich is their
natural size in JavaScript, and floats are not boxed.  As a
consequence, marshalling, polymorphic comparison, and hashing
functions can yield results different from usual:
  * marshalling of floats is not supported (unmarshalling works);
  * the polymorphic hash function will not give the same results on
    datastructures containing floats;
  * these functions may be more prone to stack overflow.

== Contents of the distribution ==

|    LICENSE     |   license and copyright notice                   |
|    README      |   this file                                      |
|    compiler/   |   compiler                                       |
|    examples/   |   small examples                                 |
|    lib/        |   library for interfacing with JavaScript APIs   |
|    runtime/    |   runtime system                                 |


{'fraction_non_alphanumeric': 0.0660436137071651, 'fraction_numerical': 0.003894080996884735, 'mean_word_length': 2.915243902439024, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 7, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '335032', 'n_tokens_mistral': 1774, 'n_tokens_neox': 1647, 'n_words': 790}