Skip to content
This repository
Newer
Older
100644 100 lines (63 sloc) 2.874 kb
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
1 Welcome to OCaml Batteries Included
2 ===================================
716c059b » yoric
2008-10-12 Hunting for the elusive top-level bug.
3
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
4 ***OCaml Batteries Included***, or just ***Batteries***, is a
5 community-maintained foundation library for your OCaml projects.
6 Batteries
8eddc9b2 » yoric
2008-10-10 Documenting authors.
7
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
8 * defines a standard set of libraries which may be expected on every
9 compliant installation of OCaml;
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
10
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
11 * organizes these libraries into a hierarchy of modules, with a single
12 source of documentation; and
8eddc9b2 » yoric
2008-10-10 Documenting authors.
13
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
14 * provides a consistent API for otherwise independent libraries.
15
16
17 Building Batteries
18 ------------------
19
20 ### Requirements
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
21
22 You will need the following libraries:
81b9a228 » David Teller
2009-03-31 Build documentation updated.
23
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
24 * [OCaml][] >= 3.11
25 * [Findlib][] >= 1.2.5
26 * [Camomile][] >= 0.7
27 * GNU make
28 * [OUnit][] to build and run the tests
6205341b » yoric
2008-09-27 Indirection decrease completed.
29
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
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/
77f93810 » thelema
2010-07-08 Changes to work with Camomile 0.8.1
34
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
35 ### Configuration and Installation
36
37 To install the full version of Batteries, execute
8eddc9b2 » yoric
2008-10-10 Documenting authors.
38
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
39 $ make all
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
40 $ make test test [ optional ]
41 $ sudo make install
d6367b8e » thelema
2010-01-03 move aaa to mainline
42
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
43 $ make doc [ optional ]
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
44 $ sudo make install-doc [ optional ]
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
45
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
46 If you want the documentation installed elsewhere, set this *before*
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
47 starting the build process because this location is stored in the
48 `Batteries_config` module generated during compilation.
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
49
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
50 $ export DOCROOT=/path/to/new/docroot/
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
51
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
52 If you want findlib to use a `-destdir` argument to `ocamlfind install`, set
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
53
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
54 $ export DESTDIR=/path/to/findlib/dest
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
55
56 To disable native compilation:
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
57
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
58 $ export BATTERIES_NATIVE=false
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
59
92454590 » elehack
2010-04-10 Support building shared libraries.
60 To disable building of native shared libraries:
61
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
62 $ export BATTERIES_NATIVE_SHLIB=false
92454590 » elehack
2010-04-10 Support building shared libraries.
63
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
64
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
65 Using Batteries
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
66 ---------------
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
67
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
68 To get started using Batteries at the toplevel, copy the `ocamlinit`
69 file to `~/.ocamlinit`:
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
70
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
71 $ cp ocamlinit ~/.ocamlinit
8eddc9b2 » yoric
2008-10-10 Documenting authors.
72
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
73 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8e » thelema
2010-01-03 move aaa to mainline
74 last line in our ocamlinit to load batteries.
6205341b » yoric
2008-09-27 Indirection decrease completed.
75
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
76 More usage help available on the [batteries-included wiki][batwiki].
77
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
78 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d805 » thelema
2010-07-05 README* and doc/* cleanups
79
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
80 ExtLib Compatibility
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
81 --------------------
6205341b » yoric
2008-09-27 Indirection decrease completed.
82
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
83 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
84 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26aa » thelema
2010-01-03 Remove most references to AAA
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.
6205341b » yoric
2008-09-27 Indirection decrease completed.
88
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
89 [ExtLib]: http://code.google.com/p/ocaml-extlib/
90
d6367b8e » thelema
2010-01-03 move aaa to mainline
91 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
92 have a corresponding module in batteries at the moment.
6205341b » yoric
2008-09-27 Indirection decrease completed.
93
94
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
95 Extending Batteries
96 -------------------
97
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
98 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
99
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
100 [batwiki-dev]: https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
Something went wrong with that request. Please try again.