File: README.md

package info (click to toggle)
react 1.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,136 kB
  • ctags: 655
  • sloc: ml: 3,843; makefile: 27
file content (53 lines) | stat: -rw-r--r-- 1,699 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
React — Declarative events and signals for OCaml
-------------------------------------------------------------------------------
Release 1.2.0

React is an OCaml module for functional reactive programming (FRP). It
provides support to program with time varying values : declarative
events and signals. React doesn't define any primitive event or
signal, it lets the client chooses the concrete timeline.

React is made of a single, independent, module and distributed under
the BSD3 license.

Home page: http://erratique.ch/software/react  
Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`


## Installation

React can be installed with `opam`:

    opam install react

If you don't use `opam` consult the [`opam`](opam) file for build
instructions.


## Documentation

The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][3]
and there is a generated version in the `doc` directory of the
distribution.

[3]: http://erratique.ch/software/react/doc/React


## Sample programs

If you installed React with `opam` sample programs are located in
the directory `opam config var react:doc`.

In the distribution sample programs are located in the `test`
directory of the distribution. They can be built with:

    ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in `_build/test`.

- `test.native` tests the library, nothing should fail.
- `clock.native` is a command line program using ANSI escape sequences
  and the Unix module to print the current local time.
- `breakout.native` is a command line program using ANSI escape sequences
  and the Unix module to implement a simple breakout game.