Unicode character properties for OCaml
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
pkg
src
support
test
.gitignore
.merlin
.ocp-indent
CHANGES.md
DEVEL.md
LICENSE.md
README.md
TODO.md
_tags
opam

README.md

Uucp — Unicode character properties for OCaml

%%VERSION%% — Unicode version %%UNICODE_VERSION%%

Uucp is an OCaml library providing efficient access to a selection of character properties of the Unicode character database.

Uucp is independent from any Unicode text data structure and has no dependencies. It is distributed under the ISC license.

Home page: http://erratique.ch/software/uucp
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Installation

Uucp can be installed with opam:

opam install uucp
opam install cmdliner uutf uunf uucp # for ucharinfo cli tool

If you don't use opam consult the opam file for build instructions and a complete specification of the dependencies.

Documentation

Uucp has a minimal Unicode introduction and some Unicode OCaml tips.

The documentation and API reference is automatically generated from the interfaces. It can be consulted online or via odig doc uucp.

Sample programs

The ucharinfo tool allows to report character information on the command line.

Sample programs are located in the test directory of the distribution. They can be built with:

topkg build --tests true

The resulting binaries are in _build/test :

  • test.native tests the library. Nothing should fail.
  • perf.native tests the performance of the library.

Authors

  • Daniel C. Bünzli, main developer.
  • David Kaloper Meršinjak, Uucp.Break.tty_width_hint function.