Added some documentation, license file.

[perl4caml.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..98907ca
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+perl4caml
+Copyright (C) 2003 Merjis Ltd. (http://www.merjis.com/)
+$Id: README,v 1.1 2003-10-14 16:46:13 rich Exp $
+
+perl4caml allows you to use Perl code within Objective CAML (OCaml),
+thus neatly side-stepping the old problem with OCaml which was that it
+lacked a comprehensive set of libraries. Well now you can use any part
+of CPAN in your OCaml code.
+
+mod_caml is distributed under the GNU Library General Public License
+(see file COPYING.LIB for terms and conditions).
+
+mod_caml was mainly written by Richard W.M. Jones
+(rich@annexia.org). See file AUTHORS for other contributors.
+
+       Installation
+       ------------
+
+(1) You will need the Perl development environment installed. I'm using
+    Perl 5.8.x. It is likely that earlier versions may have small
+    incompatibilities.
+
+(2) Edit Makefile.config as necessary.
+
+(3) Type 'make'.
+
+(4) Type 'make install' as root to install.
+
+(5) Try some of the examples in the examples/ directory (some of these
+    require that you have certain Perl modules installed).