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