Blame src/hb-ucdn/README

Packit 874993
Contents of this directory are derived from UCDN:
Packit 874993
Packit 874993
  https://github.com/grigorig/ucdn
Packit 874993
Packit 874993
The original README follows:
Packit 874993
Packit 874993
Packit 874993
UCDN - Unicode Database and Normalization
Packit 874993
Packit 874993
UCDN is a Unicode support library. Currently, it provides access
Packit 874993
to basic character properties contained in the Unicode Character
Packit 874993
Database and low-level normalization functions (pairwise canonical
Packit 874993
composition/decomposition and compatibility decomposition). More
Packit 874993
functionality might be provided in the future, such as additional
Packit 874993
properties, string normalization and encoding conversion.
Packit 874993
Packit 874993
UCDN uses standard C89 with no particular dependencies or requirements
Packit 874993
except for stdint.h, and can be easily integrated into existing
Packit 874993
projects. However, it can also be used as a standalone library,
Packit 874993
and a CMake build script is provided for this. The first motivation
Packit 874993
behind UCDN development was to provide a standalone set of Unicode
Packit 874993
functions for the HarfBuzz OpenType shaping library. For this purpose,
Packit 874993
a HarfBuzz-specific wrapper is shipped along with it (hb-ucdn.h).
Packit 874993
Packit 874993
UCDN is published under the ISC license, please see the license header
Packit 874993
in the C source code for more information. The makeunicodata.py script
Packit 874993
required for parsing Unicode database files is licensed under the
Packit 874993
PSF license, please see PYTHON-LICENSE for more information.
Packit 874993
Packit 874993
UCDN was written by Grigori Goronzy <greg@kinoho.net>.
Packit 874993
Packit 874993
How to Use
Packit 874993
Packit 874993
Include ucdn.c, ucdn.h and unicodedata_db.h in your project. Now,
Packit 874993
just use the functions as documented in ucdn.h.
Packit 874993
Packit 874993
In some cases, it might be necessary to regenerate the Unicode
Packit 874993
database file. The script makeunicodedata.py (Python 3.x required)
Packit 874993
fetches the appropriate files and dumps the compressed database into
Packit 874993
unicodedata_db.h.