Skip to content
This repository
Newer
Older
100644 102 lines (65 sloc) 3.011 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
5041b23e » thelema
2012-11-28 Update README.md
24 * [OCaml][] >= 3.12.1
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
25 * [Findlib][] >= 1.2.5
26 * [Camomile][] >= 0.7
27 * GNU make
28 * [OUnit][] to build and run the tests
5b196799 » gasche
2010-10-16 A new benchsuite/ repertory for performance measurements.
29 * [ocaml-benchmark][] to build and run the performance tests (optional)
6205341b » yoric
2008-09-27 Indirection decrease completed.
30
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
31 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
32 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
33 [Camomile]: http://camomile.sourceforge.net/
34 [OUnit]: http://ounit.forge.ocamlcore.org/
5b196799 » gasche
2010-10-16 A new benchsuite/ repertory for performance measurements.
35 [ocaml-benchmark]: http://ocaml-benchmark.forge.ocamlcore.org/
77f93810 » thelema
2010-07-08 Changes to work with Camomile 0.8.1
36
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
37 ### Configuration and Installation
38
39 To install the full version of Batteries, execute
8eddc9b2 » yoric
2008-10-10 Documenting authors.
40
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
41 $ make all
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
42 $ make test test [ optional ]
43 $ sudo make install
d6367b8e » thelema
2010-01-03 move aaa to mainline
44
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
45 $ make doc [ optional ]
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
46 $ sudo make install-doc [ optional ]
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
47
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
48 If you want the documentation installed elsewhere, set this *before*
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
49 starting the build process because this location is stored in the
50 `Batteries_config` module generated during compilation.
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
51
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
52 $ export DOCROOT=/path/to/new/docroot/
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
53
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
54 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
55
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
56 $ export DESTDIR=/path/to/findlib/dest
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
57
58 To disable native compilation:
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
59
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
60 $ export BATTERIES_NATIVE=false
8776f17c » thelema
2010-02-18 Lots of environment variables to configure build/install
61
92454590 » elehack
2010-04-10 Support building shared libraries.
62 To disable building of native shared libraries:
63
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
64 $ export BATTERIES_NATIVE_SHLIB=false
92454590 » elehack
2010-04-10 Support building shared libraries.
65
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
66
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
67 Using Batteries
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
68 ---------------
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
69
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
70 To get started using Batteries at the toplevel, copy the `ocamlinit`
71 file to `~/.ocamlinit`:
f44b225d » David Teller
2008-11-10 Still moving around GODI package.
72
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
73 $ cp ocamlinit ~/.ocamlinit
8eddc9b2 » yoric
2008-10-10 Documenting authors.
74
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
75 If you already have findlib in your `~/.ocamlinit`, you only need the
d6367b8e » thelema
2010-01-03 move aaa to mainline
76 last line in our ocamlinit to load batteries.
6205341b » yoric
2008-09-27 Indirection decrease completed.
77
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
78 More usage help available on the [batteries-included wiki][batwiki].
79
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
80 [batwiki]: https://github.com/ocaml-batteries-team/batteries-included/wiki/
72f6d805 » thelema
2010-07-05 README* and doc/* cleanups
81
04b388a7 » thelema
2011-01-20 markup-ize the readme, remove note on camomile
82 ExtLib Compatibility
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
83 --------------------
6205341b » yoric
2008-09-27 Indirection decrease completed.
84
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
85 If your project currently uses [ExtLib][], most likely you can just change
bfa2fb5e » thelema
2011-01-20 forgot to commit changes to README.md
86 `-package extlib` to `-package batteries` and add `open Extlibcompat`
ff0c26aa » thelema
2010-01-03 Remove most references to AAA
87 to the top of any extlib-using modules. Batteries' modules are all
88 named BatFoo to differentiate them from extlib's modules, so one can
89 use Batteries and ExtLib in the same project.
6205341b » yoric
2008-09-27 Indirection decrease completed.
90
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
91 [ExtLib]: http://code.google.com/p/ocaml-extlib/
92
d6367b8e » thelema
2010-01-03 move aaa to mainline
93 COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
94 have a corresponding module in batteries at the moment.
6205341b » yoric
2008-09-27 Indirection decrease completed.
95
96
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
97 Extending Batteries
98 -------------------
99
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
100 See doc/batteries/GUIDELINES and the [guidelines wiki page][batwiki-dev].
a2b686c2 » chaudhuri
2011-02-04 Edits, mostly tweaks, to README.md
101
7898bb9b » chaudhuri
2011-02-07 Fix URLs that I inadvertently broke to the wiki in README.md
102 [batwiki-dev]: https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines
Something went wrong with that request. Please try again.