Skip to content
Newer
Older
100644 102 lines (64 sloc) 2.93 KB
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
1 Welcome to OCaml Batteries Included
2 ===================================
716c059 Hunting for the elusive top-level bug.
yoric authored Oct 12, 2008
3
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
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 Oct 10, 2008
7
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
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 Jan 20, 2011
10
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
11 * organizes these libraries into a hierarchy of modules, with a single
12 source of documentation; and
8eddc9b Documenting authors.
yoric authored Oct 10, 2008
13
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
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 Jan 20, 2011
21
22 You will need the following libraries:
81b9a22 Build documentation updated.
David Teller authored Mar 31, 2009
23
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
24 * [OCaml][] >= 3.11
25 * [Findlib][] >= 1.2.5
26 * GNU make
2242376 @thelema [Fix #90] Use CamelCase module names, minor fixes to README, importan…
thelema authored May 20, 2011
27 * [OUnit][] to build and run the tests (optional)
5b19679 @gasche A new benchsuite/ repertory for performance measurements.
gasche authored Oct 16, 2010
28 * [ocaml-benchmark][] to build and run the performance tests (optional)
6205341 Indirection decrease completed.
yoric authored Sep 27, 2008
29
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
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 Oct 16, 2010
34 [ocaml-benchmark]: http://ocaml-benchmark.forge.ocamlcore.org/
77f9381 @thelema Changes to work with Camomile 0.8.1
thelema authored Jul 8, 2010
35
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
36 ### Configuration and Installation
37
38 To install the full version of Batteries, execute
8eddc9b Documenting authors.
yoric authored Oct 10, 2008
39
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
40 $ make all
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
41 $ make test test [ optional ]
42 $ sudo make install
d6367b8 @thelema move aaa to mainline
thelema authored Jan 3, 2010
43
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
44 $ make doc [ optional ]
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
45 $ sudo make install-doc [ optional ]
f44b225 Still moving around GODI package.
David Teller authored Nov 10, 2008
46
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored Feb 18, 2010
47 If you want the documentation installed elsewhere, set this *before*
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
48 starting the build process because this location is stored in the
49 `Batteries_config` module generated during compilation.
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored Feb 18, 2010
50
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
51 $ export DOCROOT=/path/to/new/docroot/
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored Feb 18, 2010
52
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
53 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 Feb 18, 2010
54
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
55 $ export DESTDIR=/path/to/findlib/dest
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored Feb 18, 2010
56
57 To disable native compilation:
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
58
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
59 $ export BATTERIES_NATIVE=false
8776f17 @thelema Lots of environment variables to configure build/install
thelema authored Feb 18, 2010
60
9245459 @mdekstrand Support building shared libraries.
mdekstrand authored Apr 10, 2010
61 To disable building of native shared libraries:
62
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
63 $ export BATTERIES_NATIVE_SHLIB=false
9245459 @mdekstrand Support building shared libraries.
mdekstrand authored Apr 11, 2010
64
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
65
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
66 Using Batteries
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
67 ---------------
f44b225 Still moving around GODI package.
David Teller authored Nov 10, 2008
68
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored Jan 20, 2011
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 Nov 10, 2008
71
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
72 $ cp ocamlinit ~/.ocamlinit
8eddc9b Documenting authors.
yoric authored Oct 10, 2008
73
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored Jan 20, 2011
74 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8 @thelema move aaa to mainline
thelema authored Jan 3, 2010
75 last line in our ocamlinit to load batteries.
6205341 Indirection decrease completed.
yoric authored Sep 27, 2008
76
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
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 Feb 7, 2011
79 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d80 @thelema README* and doc/* cleanups
thelema authored Jul 5, 2010
80
04b388a @thelema markup-ize the readme, remove note on camomile
thelema authored Jan 20, 2011
81 ExtLib Compatibility
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
82 --------------------
6205341 Indirection decrease completed.
yoric authored Sep 27, 2008
83
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
84 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5 @thelema forgot to commit changes to README.md
thelema authored Jan 20, 2011
85 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26a @thelema Remove most references to AAA
thelema authored Jan 3, 2010
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 Sep 27, 2008
89
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
90 [ExtLib]: http://code.google.com/p/ocaml-extlib/
91
d6367b8 @thelema move aaa to mainline
thelema authored Jan 3, 2010
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 Sep 27, 2008
94
95
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
96 Extending Batteries
97 -------------------
98
7898bb9 @chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored Feb 7, 2011
99 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c @chaudhuri Edits, mostly tweaks, to README.md
chaudhuri authored Feb 4, 2011
100
7898bb9 @chaudhuri Fix URLs that I inadvertently broke to the wiki in README.md
chaudhuri authored Feb 7, 2011
101 [batwiki-dev]: https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
Something went wrong with that request. Please try again.