README

   1                        The ocaml-event library
   2
   3 Overview
   4
   5   ocaml-event is a wrapper for the libevent API. The libevent API
   6   provides a mechanism to execute a callback function when a specific
   7   event occurs on a file descriptor or after a timeout has been
   8   reached. Furthermore, libevent also support callbacks due to signals
   9   or regular timeouts. Libevent is meant to replace the event loop
  10   found in event driven network servers. An application just needs to
  11   call event_dispatch() and then adds or removes events dynamically
  12   without having to change the event loop. This wrapper makes the
  13   libevent library available for ocaml programmers.
  14
  15 Installation
  16
  17   - Download, compile, and install libevent.
  18     See http://libevent.org
  19
  20   - Edit the variables at the beginning of the Makefile to reflect the
  21     location where libevent is installed on your system.
  22
  23   - Do make depend; make all
  24
  25   - If the Objective Caml native-code compiler is available on your
  26     platform (look for the "ocamlopt" executable), do "make allopt".
  27
  28   - To generate the documentation, do "make doc"
  29
  30   - (Optional) To test the library, do "make test". This requires the
  31     installation of OUnit.
  32
  33   - (Optional) To test the library compiled with ocamlopt and ocamlc,
  34     do "make testall". This requires the installation of OUnit.
  35
  36   - Become super-user if necessary and do "make install".  This
  37     installs the library in the standard Objective Caml library
  38     directory.
  39
  40 Documentation
  41
  42   See the HTML documentation in doc/index.html
  43
  44 References
  45
  46   libevent::<http://libevent.org>