******************************************************************************
INSTALL - Equeue, event queues for O'Caml
******************************************************************************


==============================================================================
The "equeue" package
==============================================================================

------------------------------------------------------------------------------
Prerequisites
------------------------------------------------------------------------------

Equeue does not need any other packages besides the O'Caml core. Equeue is 
known to work with O'Caml 2.04 and O'Caml 3.00. The installation procedure 
defined in the Makefile requires findlib [1] to work [2]. 

If you want to have the TCL queue extension, you need camltk or labltk. 

------------------------------------------------------------------------------
Configuration
------------------------------------------------------------------------------

It is not necessary to configure the core of "equeue". 

If you are going to use the TCL queue extension, it might be necessary to edit 
the file tcl/Makefile and set the variable TCL_H to the directory where the 
tcl.h header file is installed. 

------------------------------------------------------------------------------
Compilation
------------------------------------------------------------------------------

The Makefile defines the following goals: 

-  make all
   compiles with the bytecode compiler and creates equeue.cma (the standard 
   version), equeue_g.cma (version with debug information), and equeue_mt.cma 
   (version prepared for multi-threading) 
   
-  make opt
   compiles with the native compiler and creates equeue.cmxa (the standard 
   version), and equeue_mt.cmxa (version prepared for multi-threading) 
   
-  make tcl
   compiles the library with TCL queue extension, and produces the bytecode 
   archive equeue_tcl.cma.
   
-  make tcl_opt
   compiles the library with TCL queue extension, and produces the native 
   archive equeue_tcl.cmxa.
   
------------------------------------------------------------------------------
Installation
------------------------------------------------------------------------------

The Makefile defines the following goals:

-  make install
   installs the bytecode archives, the interface definitions, and if present, 
   the native archives in the default location of findlib 
   
-  make uninstall
   removes the package
   
==============================================================================
The examples
==============================================================================

In the "examples" directory you find several code examples how to use Equeue. 
They require that Equeue has been installed using findlib. See the Makefiles in 
the directories for descriptions of "make" goals. 

Most examples require a toploop with support for the Unix and Findlib modules. 
You can create such a toploop by: 

ocamlfind ocamlmktop -o toploop -package unix,findlib -linkpkg -custom




--------------------------

[1]   see http://www.ocaml-programming.de/packages/documentation/findlib/

[2]   Findlib is a package manager, see the file ABOUT-FINDLIB.



