Skip to content

Commit

Permalink
Add a non-explicit note about terminal.ansi & unikernels and how to a…
Browse files Browse the repository at this point in the history
…void the unix dependency from this library to progress.engine
  • Loading branch information
dinosaure committed May 20, 2024
1 parent d318e14 commit 423d634
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/terminal/ansi/terminal_ansi.mli
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@
————————————————————————————————————————————————————————————————————————————*)

(** This library provides a small set of standard utility functions for
interacting with terminals. *)
interacting with terminals.
Note that this module does not depend on the [unix] library. There is
therefore a way to use [Terminal_ansi] and [progress.engine] in a context
other than a POSIX system (such as a unikernel). To do this, you need to
compose [Terminal_ansi] with a library that looks like [terminal.unix]
(which should allow you to obtain the size of a TTY). It would then be
sufficient to compose the latter (just as the [terminal] library does) to
then be able to use [Progess_engine.Make] with the result of this
composition.
*)

module Color : sig
type t
Expand Down

0 comments on commit 423d634

Please sign in to comment.