Quick Start
Typical users should download a utf8proc release rather than cloning directly from github.
For compilation of the C library, run make. You can also install the library and header file with make install (by default into /usr/local/lib and /usr/local/bin, but this can be changed by make prefix=/some/dir). make check runs some tests, and make clean deletes all of the generated files.
Alternatively, you can compile with cmake, e.g. by
mkdir build
cmake -S . -B build
cmake --build build
C Library
The documentation for the C library is found in the utf8proc.h header file.
utf8proc_map is function you will most likely be using for mapping UTF-8
strings, unless you want to allocate memory yourself.
To Do
See the Github issues list.
See also
An independent Lua translation of this library, lua-mojibake, is also available.