-------------------------------------------------------------------------------
Rtime - Timelines for OCaml's React module
Release 0.9.3
-------------------------------------------------------------------------------
Rtime is an OCaml module implementing timelines for [React][1]. It
manages time stamp events, delayed events and delayed signals along
timelines. The client chooses the concrete timeline by providing an
absolute notion of time. Running the timeline at the appropriate pace
is left to the client.
Rtime is made of a single module and depends on [React][1]. It is
distributed under the BSD3 license.
[1]: http://erratique.ch/software/react
Home page: http://erratique.ch/software/rtime
Contact: Daniel Bünzli <daniel.buenzli at erratique.ch>
Installation
------------
To install Rtime you need at least :
OCaml >= 3.11.0
react
If you have `findlib`, it can be installed by typing :
ocaml setup.ml -configure
ocaml setup.ml -build
ocaml setup.ml -install
If you don't, `rtime.mli` and `rtime.ml` contain everything, the
code, the documentation and the license. Install the dependencies and
use the sources the way you want. For example if you use `ocamlbuild`
you can issue the following commands from the root directory of your
project :
ln -s /path/to/rtime-0.9.3/src rtime
echo "<rtime> : include" >> _tags
Documentation
-------------
The documentation and API reference is automatically generated by
`ocamldoc` from `rtime.mli`. For you convenience you can find a
generated version in the `doc` directory of the distribution.
Sample programs
---------------
Sample programs are located in the `test` directory of the
distribution. They can be built with:
ocamlbuild test/tests.otarget
The resulting binaries are in `_build/test` :
- `test.native` tests the library, nothing should fail. Note that it
may fail in a heavily loaded environment or if the system's timers
are not precise enough. You can adjust the tolerance to precision
with `-p`, see `test.native -help` for more information.
