README

inuit — Make interactive text-based user-interfaces in OCaml

v0.4.1

Inuit is an abstraction for interactively updating a text buffer. It is designed to be use with a backend that will present the buffer to the end user.Sturgeon is a backend targeting emacs buffers.

Inuit is distributed under the ISC license.

Homepage: https://github.com/let-def/inuit
Contact: Frédéric Bour<frederic.bour@lakaban.net>

Installation

inuit can be installed withopam:

opam install inuit

If you don't useopam consult theopam file for build instructions.

Documentation

The documentation and API reference is automatically generated byocamldoc from the interfaces. It can be consultedonline and there is a generated version in thedoc directory of the distribution.

Sample programs

If you installed inuit withopam sample programs are located in the directoryopam config var inuit:doc.

In the distribution sample programs and tests are located in thetest 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.

1. grenier>= "0.4"
2. jbuilder>= "1.0+beta7"
3. ocaml>= "4.01.0"

None

1. statmemprof-emacs
2. sturgeon

None