Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 105 lines (67 sloc) 3.206 kb
a2b686c @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 @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 @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 @thelema forgot to commit changes to README.md
thelema authored
10
a2b686c @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 @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
14 * provides a consistent API for otherwise independent libraries.
15
ea78b70 @c-cube 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 @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
17
18 Building Batteries
19 ------------------
20
21 ### Requirements
04b388a @thelema 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 @thelema Bump required ocaml version to 3.12.1 in README
thelema authored
25 * [OCaml][] >= 3.12.1
613c638 require ocamlfind>=1.5.3 for the full Bytes compatibility package
Gabriel Scherer authored
26 * [Findlib][] >= 1.5.3
b561c37 @mads379 Update tests and documentation for dump
mads379 authored
27 * [qtest][] >= 2.0.1
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
28 * GNU make
2242376 @thelema [Fix #90] Use CamelCase module names, minor fixes to README, importan…
thelema authored
29 * [OUnit][] to build and run the tests (optional)
5b19679 @gasche A new benchsuite/ repertory for performance measurements.
gasche authored
30 * [ocaml-benchmark][] to build and run the performance tests (optional)
4f1941e @sliquister adding code coverage for the tests (using bisect)
sliquister authored
31 * [bisect][] to compute the coverage of the test suite (optional)
6205341 Indirection decrease completed.
yoric authored
32
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
33 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
34 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
35 [Camomile]: http://camomile.sourceforge.net/
36 [OUnit]: http://ounit.forge.ocamlcore.org/
5b19679 @gasche A new benchsuite/ repertory for performance measurements.
gasche authored
37 [ocaml-benchmark]: http://ocaml-benchmark.forge.ocamlcore.org/
4f1941e @sliquister adding code coverage for the tests (using bisect)
sliquister authored
38 [bisect]: http://bisect.x9c.fr/
77f9381 @thelema Changes to work with Camomile 0.8.1
thelema authored
39
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
40 ### Configuration and Installation
41
42 To install the full version of Batteries, execute
8eddc9b Documenting authors.
yoric authored
43
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
44 $ make all
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
45 $ make test test [ optional ]
46 $ sudo make install
d6367b8 @thelema move aaa to mainline
thelema authored
47
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
48 $ make doc [ optional ]
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
49 $ sudo make install-doc [ optional ]
f44b225 Still moving around GODI package.
David Teller authored
50
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
51 If you want the documentation installed elsewhere, set this *before*
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
52 starting the build process because this location is stored in the
53 `Batteries_config` module generated during compilation.
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
54
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
55 $ export DOCROOT=/path/to/new/docroot/
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
56
57 To disable native compilation:
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
58
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
59 $ export BATTERIES_NATIVE=false
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
60
9245459 @mdekstrand Support building shared libraries.
mdekstrand authored
61 To disable building of native shared libraries:
62
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
63 $ export BATTERIES_NATIVE_SHLIB=false
9245459 @mdekstrand Support building shared libraries.
mdekstrand authored
64
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
65
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
66 Using Batteries
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
67 ---------------
f44b225 Still moving around GODI package.
David Teller authored
68
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored
69 To get started using Batteries at the toplevel, copy the `ocamlinit`
70 file to `~/.ocamlinit`:
f44b225 Still moving around GODI package.
David Teller authored
71
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
72 $ cp ocamlinit ~/.ocamlinit
8eddc9b Documenting authors.
yoric authored
73
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored
74 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8 @thelema move aaa to mainline
thelema authored
75 last line in our ocamlinit to load batteries.
6205341 Indirection decrease completed.
yoric authored
76
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
77 More usage help available on the [batteries-included wiki][batwiki].
78
7898bb9 @chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
79 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d80 @thelema README* and doc/* cleanups
thelema authored
80
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
81 ExtLib Compatibility
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
82 --------------------
6205341 Indirection decrease completed.
yoric authored
83
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
84 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored
85 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26a @thelema Remove most references to AAA
thelema authored
86 to the top of any extlib-using modules. Batteries' modules are all
87 named BatFoo to differentiate them from extlib's modules, so one can
88 use Batteries and ExtLib in the same project.
6205341 Indirection decrease completed.
yoric authored
89
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
90 [ExtLib]: http://code.google.com/p/ocaml-extlib/
91
d6367b8 @thelema move aaa to mainline
thelema authored
92 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
93 have a corresponding module in batteries at the moment.
6205341 Indirection decrease completed.
yoric authored
94
95
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
96 Extending Batteries
97 -------------------
98
7898bb9 @chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
99 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
100
7898bb9 @chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
101 [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
102
cf1d02d @thelema Update README.md to have a little better description of `batteries_de…
thelema authored
103 If you use emacs, the file `batteries_dev.el` has extra highlighting to support writing quicktests.
4ff1d61 @c-cube summary of changes in README
c-cube authored
104
Something went wrong with that request. Please try again.