Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 100 lines (63 sloc) 2.928 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
16
17 Building Batteries
18 ------------------
19
20 ### Requirements
04b388a Edgar Friendly 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
ab284da Hezekiah M. Carty Batteries requires OCaml 3.12.0 or later now
hcarty authored
24 * [OCaml][] >= 3.12
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
25 * [Findlib][] >= 1.2.5
26 * GNU make
2242376 Edgar Friendly [Fix #90] Use CamelCase module names, minor fixes to README, important f...
thelema authored
27 * [OUnit][] to build and run the tests (optional)
5b19679 gasche A new benchsuite/ repertory for performance measurements.
gasche authored
28 * [ocaml-benchmark][] to build and run the performance tests (optional)
6205341 Indirection decrease completed.
yoric authored
29
a2b686c Kaustuv 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/
5b19679 gasche A new benchsuite/ repertory for performance measurements.
gasche authored
34 [ocaml-benchmark]: http://ocaml-benchmark.forge.ocamlcore.org/
77f9381 Edgar Friendly Changes to work with Camomile 0.8.1
thelema authored
35
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
36 ### Configuration and Installation
37
38 To install the full version of Batteries, execute
8eddc9b Documenting authors.
yoric authored
39
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
40 $ make all
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
41 $ make test test [ optional ]
42 $ sudo make install
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
43
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
44 $ make doc [ optional ]
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
45 $ sudo make install-doc [ optional ]
f44b225 Still moving around GODI package.
David Teller authored
46
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
47 If you want the documentation installed elsewhere, set this *before*
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
48 starting the build process because this location is stored in the
49 `Batteries_config` module generated during compilation.
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
50
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
51 $ export DOCROOT=/path/to/new/docroot/
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
52
53 To disable native compilation:
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
54
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
55 $ export BATTERIES_NATIVE=false
8776f17 Edgar Friendly Lots of environment variables to configure build/install
thelema authored
56
9245459 Michael Ekstrand Support building shared libraries.
elehack authored
57 To disable building of native shared libraries:
58
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
59 $ export BATTERIES_NATIVE_SHLIB=false
9245459 Michael Ekstrand Support building shared libraries.
elehack authored
60
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
61
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
62 Using Batteries
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
63 ---------------
f44b225 Still moving around GODI package.
David Teller authored
64
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
65 To get started using Batteries at the toplevel, copy the `ocamlinit`
66 file to `~/.ocamlinit`:
f44b225 Still moving around GODI package.
David Teller authored
67
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
68 $ cp ocamlinit ~/.ocamlinit
8eddc9b Documenting authors.
yoric authored
69
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
70 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
71 last line in our ocamlinit to load batteries.
6205341 Indirection decrease completed.
yoric authored
72
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
73 More usage help available on the [batteries-included wiki][batwiki].
74
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
75 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d80 Edgar Friendly README* and doc/* cleanups
thelema authored
76
04b388a Edgar Friendly markup-ize the readme, remove note on camomile
thelema authored
77 ExtLib Compatibility
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
78 --------------------
6205341 Indirection decrease completed.
yoric authored
79
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
80 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5 Edgar Friendly forgot to commit changes to README.md
thelema authored
81 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26a Edgar Friendly Remove most references to AAA
thelema authored
82 to the top of any extlib-using modules. Batteries' modules are all
83 named BatFoo to differentiate them from extlib's modules, so one can
84 use Batteries and ExtLib in the same project.
6205341 Indirection decrease completed.
yoric authored
85
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
86 [ExtLib]: http://code.google.com/p/ocaml-extlib/
87
d6367b8 Edgar Friendly move aaa to mainline
thelema authored
88 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
89 have a corresponding module in batteries at the moment.
6205341 Indirection decrease completed.
yoric authored
90
91
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
92 Extending Batteries
93 -------------------
94
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
95 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c Kaustuv Chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored
96
7898bb9 Kaustuv Chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored
97 [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
98
99 If you use emacs, take a look at batteries_dev.el.
Something went wrong with that request. Please try again.