CIL: Include dynlink for OCaml 3.11.

[ocaml-bitstring.git] / README

diff --git a/README b/README
index 75edaf5..f49f63a 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,40 @@
-ocaml-bitmatch copyright (C) 2008 Red Hat Inc.
-License: LGPLv2+ with OCaml linking exception.
+ocaml-bitstring Copyright (C) 2008 Red Hat Inc, Richard W.M. Jones.
+
+This library was formerly known as 'bitmatch'.
 
 Please see the html subdirectory for developer documentation.
 
-The only dependencies are OCaml >= 3.10.0, camlp4, ocamldoc, and findlib.
+The only requirements are OCaml >= 3.10.0, camlp4, ocamldoc, and findlib.
+
+If you optionally have CIL (http://cil.sourceforge.net/) installed
+then there are some nice extra tools for converting C header files
+into matchable OCaml structures.
 
 To build:
 
        ./configure
        make
 
-       make test               # optional, to run tests
+Other make targets:
+
+       make test               # build and run the test suite
+
+       make examples           # build the examples
 
-       make print-tests        # optional, to print expanded test macros
-       make print-examples     # optional, to print expanded example macros
+       make print-tests        # print expanded test macros
+       make print-examples     # print expanded example macros
 
-To install, run this as root:
+To install (as root):
 
        make install
+
+LICENSE
+----------------------------------------------------------------------
+
+The library is licensed under the LGPL v2 or later, with the OCaml
+linking exception.  See the file COPYING.LIB for full terms.
+
+Programs are licensed under the GPL v2 or later.  See the file COPYING
+for full terms.
+
+All examples and tests are public domain.