From e4dc6dbf387a25482aae1e8c8a502c0104396929 Mon Sep 17 00:00:00 2001 From: Patrick Ferris Date: Mon, 19 Jan 2026 14:53:44 +0000 Subject: [PATCH] Add .mli --- src/bruit.mli | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 src/bruit.mli diff --git a/src/bruit.mli b/src/bruit.mli new file mode 100644 index 0000000..7830867 --- /dev/null +++ b/src/bruit.mli @@ -0,0 +1,11 @@ +(** {! Bruit} is a port of the C library + {{:https://github.com/antirez/linenoise} Linenoise} to OCaml. It is not as + feature complete as the library, contributions are very welcome. + + The main entry point to the library is {! bruit}. *) + +type result = String of string option | Ctrl_c + +val bruit : string -> result +(** [bruit prompt] reads from [stdin] and returns the read string if any, and on + [ctrl+c] returns {! Ctrl_c}. *) -- 2.51.2