<commit_before>Welcome to Batteries Included 
================================
OCaml Batteries Included: the community-maintained foundation library
for your OCaml projects.


Batteries Included serves the following purposes:
* define a standard set of libraries which may be
  expected on every compliant installation of OCaml
* organize these libraries into a hierarchy of modules,
  with one source of documentation
* provide a consistent API for otherwise independent
  libraries.

Building Batteries Included 
==============================

Requirements
------------------------------
You will need the following libraries:

* OCaml >= 3.11
* Findlib >= 1.2.5  (http://projects.camlcity.org/projects/findlib.html/)
* GNU make (optional; aids build and installation)
* Camomile >= 0.7 (http://camomile.sourceforge.net/)
* OUnit    to build and run the tests

Configuration and installation
------------------------------

To install the full version of OCaml Batteries Included, execute

    $ make all
    $ make test qtest    [ optional ]
    $ sudo make install 

    $ make doc      [ optional ]
    $ sudo make install-doc   [ optional ]

If you want the documentation installed elsewhere, set this *before*
starting the build process (it becomes part of batteries_config.ml).

    $ export DOCROOT=/path/to/new/docroot/

If you want findlib to use a -destdir argument to [ocamlfind install], set

    $ export DESTDIR=/path/to/findlib/dest

To disable native compilation:
   
    $ export BATTERIES_NATIVE=false

To disable building of native shared libraries:

    $ export BATTERIES_NATIVE_SHLIB=false

Using Batteries
==============================

To get started using Batteries at the toplevel, copy the ocamlinit
file to ~/.ocamlinit:

    $ cp ocamlinit ~/.ocamlinit

If you already have findlib in your ~/.ocamlinit, you only need the
last line in our ocamlinit to load batteries.

More usage help available on the batteries-included wiki: 
http://wiki.github.com/thelema/batteries-included/

ExtLib Compatibility
==============================

If your project currently uses ExtLib, most likely you can just change
[-package extlib] to [-package batteries] and add [open Extlibcompat]
to the top of any extlib-using modules.  Batteries' modules are all
named BatFoo to differentiate them from extlib's modules, so one can
use Batteries and ExtLib in the same project.

COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
have a corresponding module in batteries at the moment.

Extending Batteries Included 
==============================

See doc/batteries/GUIDELINES and https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
<commit_msg>forgot to commit changes to README.md<commit_after>Welcome to Batteries Included 
================================
OCaml Batteries Included: the community-maintained foundation library
for your OCaml projects.


Batteries Included serves the following purposes:

* define a standard set of libraries which may be
  expected on every compliant installation of OCaml
* organize these libraries into a hierarchy of modules,
  with one source of documentation
* provide a consistent API for otherwise independent
  libraries.

Building Batteries Included 
==============================

Requirements
------------------------------
You will need the following libraries:

* OCaml >= 3.11
* [Findlib](http://projects.camlcity.org/projects/findlib.html/) >= 1.2.5  
* GNU make (optional; aids build and installation)
* [Camomile](http://camomile.sourceforge.net/) >= 0.7 
* [OUnit](http://ounit.forge.ocamlcore.org/)    to build and run the tests

Configuration and installation
------------------------------

To install the full version of OCaml Batteries Included, execute

    $ make all
    $ make test qtest    [ optional ]
    $ sudo make install 

    $ make doc      [ optional ]
    $ sudo make install-doc   [ optional ]

If you want the documentation installed elsewhere, set this *before*
starting the build process (it becomes part of `batteries_config.ml`).

    $ export DOCROOT=/path/to/new/docroot/

If you want findlib to use a `-destdir` argument to [ocamlfind install], set

    $ export DESTDIR=/path/to/findlib/dest

To disable native compilation:
   
    $ export BATTERIES_NATIVE=false

To disable building of native shared libraries:

    $ export BATTERIES_NATIVE_SHLIB=false

Using Batteries
==============================

To get started using Batteries at the toplevel, copy the `ocamlinit`
file to `~/.ocamlinit`:

    $ cp ocamlinit ~/.ocamlinit

If you already have findlib in your `~/.ocamlinit`, you only need the
last line in our ocamlinit to load batteries.

More usage help available on the [batteries-included wiki]
(http://wiki.github.com/ocaml-batteries-team/batteries-included/)

ExtLib Compatibility
==============================

If your project currently uses ExtLib, most likely you can just change
`-package extlib` to `-package batteries` and add `open Extlibcompat`
to the top of any extlib-using modules.  Batteries' modules are all
named BatFoo to differentiate them from extlib's modules, so one can
use Batteries and ExtLib in the same project.

COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
have a corresponding module in batteries at the moment.

Extending Batteries Included 
==============================

See doc/batteries/GUIDELINES and the [guidelines wiki page](https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines)

{'fraction_non_alphanumeric': 0.13765109146671478, 'fraction_numerical': 0.002886523543207649, 'mean_word_length': 3.9061946902654867, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '31582', 'n_tokens_mistral': 1581, 'n_tokens_neox': 1490, 'n_words': 602}