Added README
authorRichard W.M. Jones <rich@annexia.org>
Wed, 2 Apr 2008 08:03:03 +0000 (08:03 +0000)
committerRichard W.M. Jones <rich@annexia.org>
Wed, 2 Apr 2008 08:03:03 +0000 (08:03 +0000)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..4f5dfd8
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+ocaml-bitmatch copyright (C) 2008 Red Hat Inc.
+License: LGPLv2+ with OCaml linking exception.
+
+Please see the doc/ subdirectory for developer documentation.
+
+The only dependencies are OCaml >= 3.10.0, camlp4, and findlib.
+
+To build:
+
+       ./configure
+       make
+
+       make test               # optional, to run tests
+
+       make print-tests        # optional, to print expanded test macros
+       make print-examples     # optional, to print expanded example macros
+
+To install, run this as root:
+
+       make install