README

   1 perl4caml
   2 Copyright (C) 2003 Merjis Ltd. (http://www.merjis.com/)
   3 $Id: README,v 1.4 2005-01-28 23:09:31 rich Exp $
   4
   5 perl4caml allows you to use Perl code within Objective CAML (OCaml),
   6 thus neatly side-stepping the old problem with OCaml which was that it
   7 lacked a comprehensive set of libraries. Well now you can use any part
   8 of CPAN in your OCaml code.
   9
  10 perl4caml is distributed under the GNU Library General Public License
  11 (see file COPYING.LIB for terms and conditions).
  12
  13 perl4caml was mainly written by Richard W.M. Jones
  14 (rich@annexia.org). See file AUTHORS for other contributors.
  15
  16         Installation
  17         ------------
  18
  19 (1) You will need the Perl development environment installed. I'm using
  20     Perl 5.8.x. It is likely that earlier versions may have small
  21     incompatibilities.
  22
  23 (2) Edit Makefile.config as necessary.
  24
  25 (3) Type 'make'.
  26
  27 (4) It's recommended that you run the automatic tests by using 'make test'.
  28     You should see 'All tests succeeded.'  If not, please report this
  29     to me (rich@annexia.org).  If Perl gives any warnings, such as
  30     'Attempt to free unreferenced scalar', please also report this.
  31
  32 (5) Type 'make install' as root to install.
  33
  34 (6) Try some of the examples in the examples/ directory (some of these
  35     require that you have certain Perl modules installed).
  36
  37         Documentation
  38         -------------
  39
  40 See doc/ for some documentation.
  41
  42 To build ocamldoc (automatically generated documentation for interfaces)
  43 type 'make html'. The output can be found by pointing your browser at
  44 'html/index.html'.