package inuit

  1. Overview
  2. Docs

Description

Inuit is a library making it easy to design simple interactive text applications.
This library is only a frontend, managing state and processing event. It needs an external backend to do the actual display. Currently, the only backend is provided by Sturgeon which display UIs in an emacs buffer.

Published: 09 Nov 2016

README

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

%%VERSION%%

inuit is TODO

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.

Dependencies (5)

  1. grenier
  2. topkg build
  3. ocamlbuild build
  4. ocamlfind build
  5. ocaml >= "4.01.0"

Dev Dependencies

None

Used by (1)

  1. sturgeon

Conflicts

None