This is a Unicode library in the programming language C which deals
with conversions to and from the UTF-8 format.

* Author: 

Ben Bullock <benkasminbullock@gmail.com>, <bkb@cpan.org>

* Repository: 

    https://github.com/benkasminbullock/unicode-c

* Licence: 

You can use this C code under the BSD three-clause licence, the GNU
General Public Licence, either version 2 or later, or the Perl
artistic licence.

* Version:

There is no version for this, please use the git commit numbers.

* Installation:

Building from scratch requires cfunctions:

    https://github.com/benkasminbullock/cfunctions

Alternatively, copy the header file from a Perl distribution:

    https://metacpan.org/release/JSON-Parse

The header file is under "Browse" then "unicode.h".

* Testing:

Compile with -DTEST or use "make test" to run the tests. The tests are
contained in unicode.c itself. Please refer to the source
code. Running the tests requires the "prove" utility which is part of
Perl.

* Documentation:

Documentation currently consists of the comments in the source code.

* Bugs:

Either send email or use the github "issues" pages to report bugs.

* Known problems:

** The library uses UCS2 where it should have said UTF-16, and similar
   misnamings.

** 0xFF is regarded as a valid UTF-8 first byte by some routines.

* Online version

There is an online web version of this software here:

    http://www.lemoda.net/tools/uniconvert/index.html