                Memcheck: runtime typechecking for Ocaml

INSTALL
=======================================

1. make all


USAGE
=======================================

1. generate the runtime type descriptions from the source:

     echo "open Memcheck;;" > type_descr.ml
     camlp5o path_to_memcheck/generate_type_descr.cmo \
	type_def.ml >> type_descr.ml

   This will generate a constant name_type_descr for every type
   definition found. For parametric type definitions it will be a
   function taking a type description argument for each parameter type.

2. compile the runtime type descriptions:

     ocamlc -I path_to_memcheck -c type_descr.ml

3. use it like

     open Memcheck;;
     check [Channel stdout; Verbose_trace] some_value 
		(<type_name>_type_descr arguments ...)



DOWNLOAD / DOCUMENTATION 
=======================================

see doc/index.html, online at http://www.cs.ru.nl/~tews/memcheck


TEST
=======================================

A rudimentary test is in test/test_check.ml. Run with make test.

For a big test download the latest cvs version 
of Olmar (www.cs.ru.nl/~tews/olmar). 


LICENCE
=======================================

GPL, see COPYING.


CONTACT
=======================================

Hendrik Tews <hendrik@askra.de>
