![example workflow](https://github.com/mbacarella/curses/actions/workflows/workflow.yml/badge.svg)

Bindings to curses/ncurses
====

Tools for building terminal-based user interfaces.

Overview
---

OCaml Curses is a project to provide curses / ncurses bindings for the
Objective Caml language.

It was formally known as Text Mode Kit (TMK), but the TMK part of the project
is not supported anymore, and instead we are just concentrating on providing
reliable OCaml curses bindings. The author of TMK and the original version of
the bindings was Nicolas George.

OCaml Curses is free software, under the terms of the GNU Lesser General Public
License.

Downloads
---

You can try `opam install curses`

If you're using a dune project, you can also git clone this repo into a
sub-directory and simply list `curses` in a `libraries` stanza.

Documentation
---

You can [browse the documentation](https://www.nongnu.org/ocaml-tmk/doc/)
generated by ocamldoc.

Bug reports and contributions
---

Report issues to this github project's issue tracker, or email me directly,
michael.bacarella@gmail.com.

Feel free to send me pull requests as well!

History
---

This is a fork of the now unmaintained ocaml-twk package at
https://www.nongnu.org/ocaml-tmk/

See [CHANGES.md](CHANGES.md) for change history.
