package bitstring

README.orig

ocaml-bitstring Copyright (C) 2008-2012 Red Hat Inc, Richard W.M. Jones.

This library was formerly known as 'bitmatch'.

Please see the html subdirectory for developer documentation.

The only requirements are OCaml >= 4.02.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

Other make targets:

	make check		# build and run the test suite

	make examples		# build the examples

	make print-tests	# print expanded test macros
	make print-examples	# print expanded example macros

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.