Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 100 lines (62 sloc) 2.79 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
16
17 Building Batteries
18 ------------------
19
20 ### Requirements
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
21
22 You will need the following libraries:
81b9a22 Build documentation updated.
David Teller authored
23
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
24 * [OCaml][] >= 3.11
25 * [Findlib][] >= 1.2.5
26 * [Camomile][] >= 0.7
27 * GNU make
28 * [OUnit][] to build and run the tests
6205341 Indirection decrease completed.
yoric authored
29
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
30 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
31 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
32 [Camomile]: http://camomile.sourceforge.net/
33 [OUnit]: http://ounit.forge.ocamlcore.org/
77f9381 @thelema Changes to work with Camomile 0.8.1
thelema authored
34
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
35 ### Configuration and Installation
36
37 To install the full version of Batteries, execute
8eddc9b Documenting authors.
yoric authored
38
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
39 $ make all
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
40 $ make test test [ optional ]
41 $ sudo make install
d6367b8 @thelema move aaa to mainline
thelema authored
42
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
43 $ make doc [ optional ]
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
44 $ sudo make install-doc [ optional ]
f44b225 Still moving around GODI package.
David Teller authored
45
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
46 If you want the documentation installed elsewhere, set this *before*
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
47 starting the build process because this location is stored in the
48 `Batteries_config` module generated during compilation.
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
49
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
50 $ export DOCROOT=/path/to/new/docroot/
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
51
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
52 If you want findlib to use a `-destdir` argument to `ocamlfind install`, set
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
53
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
54 $ export DESTDIR=/path/to/findlib/dest
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
55
56 To disable native compilation:
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
57
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
58 $ export BATTERIES_NATIVE=false
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored
59
9245459 @elehack Support building shared libraries.
elehack authored
60 To disable building of native shared libraries:
61
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
62 $ export BATTERIES_NATIVE_SHLIB=false
9245459 @elehack Support building shared libraries.
elehack authored
63
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
64
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
65 Using Batteries
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
66 ---------------
f44b225 Still moving around GODI package.
David Teller authored
67
bfa2fb5 @thelema 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 @thelema markup-ize the readme, remove note on camomile
thelema authored
71 $ cp ocamlinit ~/.ocamlinit
8eddc9b Documenting authors.
yoric authored
72
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored
73 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8 @thelema move aaa to mainline
thelema authored
74 last line in our ocamlinit to load batteries.
6205341 Indirection decrease completed.
yoric authored
75
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
76 More usage help available on the [batteries-included wiki][batwiki].
77
72f6d80 @thelema README* and doc/* cleanups
thelema authored
78
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored
79 ExtLib Compatibility
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
80 --------------------
6205341 Indirection decrease completed.
yoric authored
81
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
82 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored
83 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26a @thelema Remove most references to AAA
thelema authored
84 to the top of any extlib-using modules. Batteries' modules are all
85 named BatFoo to differentiate them from extlib's modules, so one can
86 use Batteries and ExtLib in the same project.
6205341 Indirection decrease completed.
yoric authored
87
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
88 [ExtLib]: http://code.google.com/p/ocaml-extlib/
89
d6367b8 @thelema move aaa to mainline
thelema authored
90 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
91 have a corresponding module in batteries at the moment.
6205341 Indirection decrease completed.
yoric authored
92
93
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
94 Extending Batteries
95 -------------------
96
97 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki].
98
99 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
Something went wrong with that request. Please try again.