Make interactive text-oriented user-interfaces for OCaml
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc/poster-ocaml-workshop-2016
src
.gitignore
CHANGES.md
LICENSE.md
README.md
inuit.opam

README.md

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

%%VERSION%%

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 with opam:

opam install inuit

If you don't use opam consult the opam file for build instructions.

Documentation

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

Sample programs

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

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