Skip to content

Commit

Permalink
markup-ize the readme, remove note on camomile
Browse files Browse the repository at this point in the history
  • Loading branch information
thelema committed Jan 20, 2011
1 parent 2d17873 commit 04b388a
Showing 1 changed file with 28 additions and 23 deletions.
51 changes: 28 additions & 23 deletions README
@@ -1,5 +1,5 @@
*** Welcome to Batteries Included *** Welcome to Batteries Included

================================
OCaml Batteries Included: the community-maintained foundation library OCaml Batteries Included: the community-maintained foundation library
for your OCaml projects. for your OCaml projects.


Expand All @@ -12,60 +12,64 @@ Batteries Included serves the following purposes:
* provide a consistent API for otherwise independent * provide a consistent API for otherwise independent
libraries. libraries.


*** Building Batteries Included *** Building Batteries Included
==============================

Requirements
------------------------------
You will need the following libraries:


**** Requirements ****
You will need
* OCaml >= 3.11 * OCaml >= 3.11
* Findlib >= 1.2.5 (http://projects.camlcity.org/projects/findlib.html/) * Findlib >= 1.2.5 (http://projects.camlcity.org/projects/findlib.html/)
* make (optional; aids build and installation) * GNU make (optional; aids build and installation)
* Camomile >= 0.7 (http://camomile.sourceforge.net/) * Camomile >= 0.7 (http://camomile.sourceforge.net/)
* OUnit to build and run the tests * OUnit to build and run the tests


**** Configuration and installation **** Configuration and installation

------------------------------
NOTE: to use camomile 0.8.2, run [make camomile82] first


To install the full version of OCaml Batteries Included, execute To install the full version of OCaml Batteries Included, execute


$ make all $ make all
$ make test [ optional ] $ make test qtest [ optional ]
$ sudo make install $ sudo make install


$ make doc [ optional ] $ make doc [ optional ]
$ sudo make install-doc [ optional ] $ sudo make install-doc [ optional ]


If you want the documentation installed elsewhere, set this *before* If you want the documentation installed elsewhere, set this *before*
starting the build process (it becomes part of batteries_config.ml). starting the build process (it becomes part of batteries_config.ml).


$ export DOCROOT=/path/to/new/docroot/ $ export DOCROOT=/path/to/new/docroot/


If you want findlib to use a -destdir argument to [ocamlfind install], set If you want findlib to use a -destdir argument to [ocamlfind install], set


$ export DESTDIR=/path/to/findlib/dest $ export DESTDIR=/path/to/findlib/dest


To disable native compilation: To disable native compilation:


$ export BATTERIES_NATIVE=false $ export BATTERIES_NATIVE=false


To disable building of native shared libraries: To disable building of native shared libraries:


$ export BATTERIES_NATIVE_SHLIB=false $ export BATTERIES_NATIVE_SHLIB=false


*** Using Batteries *** Using Batteries
==============================


To get started using Batteries at the toplevel, copy the ocamlinit To get started using Batteries at the toplevel, copy the ocamlinit
file to ~/.ocamlinit: file to ~/.ocamlinit:


$ cp ocamlinit ~/.ocamlinit $ cp ocamlinit ~/.ocamlinit


If you already have findlib in your ~/.ocamlinit, you only need the If you already have findlib in your ~/.ocamlinit, you only need the
last line in our ocamlinit to load batteries. last line in our ocamlinit to load batteries.


More usage help available on the batteries-included wiki: More usage help available on the batteries-included wiki:
http://wiki.github.com/thelema/batteries-included/ http://wiki.github.com/thelema/batteries-included/


*** ExtLib Compatibility *** ExtLib Compatibility
==============================


If your project currently uses ExtLib, most likely you can just change If your project currently uses ExtLib, most likely you can just change
[-package extlib] to [-package batteries] and add [open Extlibcompat] [-package extlib] to [-package batteries] and add [open Extlibcompat]
Expand All @@ -76,6 +80,7 @@ use Batteries and ExtLib in the same project.
COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not
have a corresponding module in batteries at the moment. have a corresponding module in batteries at the moment.


*** Extending Batteries Included *** Extending Batteries Included
==============================


See doc/batteries/GUIDELINES See doc/batteries/GUIDELINES and https://github.com/ocaml-batteries-team/batteries-included/wiki/Developers-guidelines

0 comments on commit 04b388a

Please sign in to comment.