X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=f49f63a8f03c6b7861a801b382762701bcc8702a;hb=80fd187cbf946133e98ca32d351c33132ce3ea47;hp=4f5dfd8fb7b774ac24ba93b1216cbaa830358ca7;hpb=49e925ab0fad9e8715fb1f932cccba5da28f954f;p=ocaml-bitstring.git

diff --git a/README b/README
index 4f5dfd8..f49f63a 100644
--- 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.
 
-Please see the doc/ subdirectory for developer documentation.
+This library was formerly known as 'bitmatch'.
 
-The only dependencies are OCaml >= 3.10.0, camlp4, and findlib.
+Please see the html subdirectory for developer documentation.
+
+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.