linol/fmt/_doc-dir/README.md
2024-02-20 18:15:51 +00:00

35 lines
1.1 KiB
Markdown

Fmt — OCaml Format pretty-printer combinators
-------------------------------------------------------------------------------
v0.9.0
Fmt exposes combinators to devise `Format` pretty-printing functions.
Fmt depends only on the OCaml standard library. The optional `Fmt_tty`
library that allows to setup formatters for terminal color output
depends on the Unix library. The optional `Fmt_cli` library that
provides command line support for Fmt depends on [`Cmdliner`][cmdliner].
Fmt is distributed under the ISC license.
[cmdliner]: http://erratique.ch/software/cmdliner
Home page: http://erratique.ch/software/fmt
## Installation
Fmt can be installed with `opam`:
opam install fmt
opam install base-unix cmdliner fmt # Install all optional libraries
If you don't use `opam` consult the [`opam`](opam) file for build
instructions.
## Documentation
The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][doc]
and there is a generated version in the `doc` directory of the
distribution.
[doc]: http://erratique.ch/software/fmt/doc/