Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 104 lines (66 sloc) 3.185 kb
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
1 Welcome to OCaml Batteries Included
2 ===================================
716c059 Hunting for the elusive top-level bug.
yoric authored
3
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
4 ***OCaml Batteries Included***, or just ***Batteries***, is a
5 community-maintained foundation library for your OCaml projects.
6 Batteries
8eddc9b Documenting authors.
yoric authored
7
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
8 * defines a standard set of libraries which may be expected on every
9 compliant installation of OCaml;
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
10
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
11 * organizes these libraries into a hierarchy of modules, with a single
12 source of documentation; and
8eddc9b Documenting authors.
yoric authored
13
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
14 * provides a consistent API for otherwise independent libraries.
15
ea78b70 Simon Cruanes use jenkins instead of travis
c-cube authored
16 [![Build Status](http://ci.cedeela.fr/buildStatus/icon?job=batteries)](http://ci.cedeela.fr/job/batteries)
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
17
18 Building Batteries
19 ------------------
20
21 ### Requirements
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
22
23 You will need the following libraries:
81b9a22 Build documentation updated.
David Teller authored
24
3882045 Edgar Friendly Bump required ocaml version to 3.12.1 in README
thelema authored
25 * [OCaml][] >= 3.12.1
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
26 * [Findlib][] >= 1.2.5
27 * GNU make
2242376 Edgar Friendly [Fix #90] Use CamelCase module names, minor fixes to README, important f...
thelema authored
28 * [OUnit][] to build and run the tests (optional)
5b19679 gasche A new benchsuite/ repertory for performance measurements.
gasche authored
29 * [ocaml-benchmark][] to build and run the performance tests (optional)
4f1941e sliquister adding code coverage for the tests (using bisect)
sliquister authored
30 * [bisect][] to compute the coverage of the test suite (optional)
6205341 Indirection decrease completed.
yoric authored
31
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
32 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
33 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
34 [Camomile]: http://camomile.sourceforge.net/
35 [OUnit]: http://ounit.forge.ocamlcore.org/
5b19679 gasche A new benchsuite/ repertory for performance measurements.
gasche authored
36 [ocaml-benchmark]: http://ocaml-benchmark.forge.ocamlcore.org/
4f1941e sliquister adding code coverage for the tests (using bisect)
sliquister authored
37 [bisect]: http://bisect.x9c.fr/
77f9381 Edgar Friendly Changes to work with Camomile 0.8.1
thelema authored
38
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
39 ### Configuration and Installation
40
41 To install the full version of Batteries, execute
8eddc9b Documenting authors.
yoric authored
42
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
43 $ make all
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
44 $ make test test [ optional ]
45 $ sudo make install
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
46
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
47 $ make doc [ optional ]
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
48 $ sudo make install-doc [ optional ]
f44b225 Still moving around GODI package.
David Teller authored
49
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
50 If you want the documentation installed elsewhere, set this *before*
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
51 starting the build process because this location is stored in the
52 `Batteries_config` module generated during compilation.
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
53
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
54 $ export DOCROOT=/path/to/new/docroot/
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
55
56 To disable native compilation:
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
57
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
58 $ export BATTERIES_NATIVE=false
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
59
9245459 Michael Ekstrand Support building shared libraries.
elehack authored
60 To disable building of native shared libraries:
61
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
62 $ export BATTERIES_NATIVE_SHLIB=false
9245459 Michael Ekstrand Support building shared libraries.
elehack authored
63
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
64
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
65 Using Batteries
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
66 ---------------
f44b225 Still moving around GODI package.
David Teller authored
67
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
68 To get started using Batteries at the toplevel, copy the `ocamlinit`
69 file to `~/.ocamlinit`:
f44b225 Still moving around GODI package.
David Teller authored
70
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
71 $ cp ocamlinit ~/.ocamlinit
8eddc9b Documenting authors.
yoric authored
72
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
73 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
74 last line in our ocamlinit to load batteries.
6205341 Indirection decrease completed.
yoric authored
75
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
76 More usage help available on the [batteries-included wiki][batwiki].
77
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
78 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d80 Edgar Friendly README* and doc/* cleanups
thelema authored
79
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
80 ExtLib Compatibility
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
81 --------------------
6205341 Indirection decrease completed.
yoric authored
82
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
83 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
84 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26a Edgar Friendly Remove most references to AAA
thelema authored
85 to the top of any extlib-using modules. Batteries' modules are all
86 named BatFoo to differentiate them from extlib's modules, so one can
87 use Batteries and ExtLib in the same project.
6205341 Indirection decrease completed.
yoric authored
88
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
89 [ExtLib]: http://code.google.com/p/ocaml-extlib/
90
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
91 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
92 have a corresponding module in batteries at the moment.
6205341 Indirection decrease completed.
yoric authored
93
94
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
95 Extending Batteries
96 -------------------
97
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
98 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
99
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
100 [batwiki-dev]: https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
b78b2f5 sliquister adding an emacs file for colorizing test comments in a distinctive way
sliquister authored
101
cf1d02d Edgar Friendly Update README.md to have a little better description of `batteries_dev.e...
thelema authored
102 If you use emacs, the file `batteries_dev.el` has extra highlighting to support writing quicktests.
4ff1d61 Simon Cruanes summary of changes in README
c-cube authored
103
Something went wrong with that request. Please try again.