README
1Contents of this directory are derived from UCDN:
2
3 https://github.com/grigorig/ucdn
4
5The original README follows:
6
7
8UCDN - Unicode Database and Normalization
9
10UCDN is a Unicode support library. Currently, it provides access
11to basic character properties contained in the Unicode Character
12Database and low-level normalization functions (pairwise canonical
13composition/decomposition and compatibility decomposition). More
14functionality might be provided in the future, such as additional
15properties, string normalization and encoding conversion.
16
17UCDN uses standard C89 with no particular dependencies or requirements
18except for stdint.h, and can be easily integrated into existing
19projects. However, it can also be used as a standalone library,
20and a CMake build script is provided for this. The first motivation
21behind UCDN development was to provide a standalone set of Unicode
22functions for the HarfBuzz OpenType shaping library. For this purpose,
23a HarfBuzz-specific wrapper is shipped along with it (hb-ucdn.h).
24
25UCDN is published under the ISC license, please see the license header
26in the C source code for more information. The makeunicodata.py script
27required for parsing Unicode database files is licensed under the
28PSF license, please see PYTHON-LICENSE for more information.
29
30UCDN was written by Grigori Goronzy <greg@kinoho.net>.
31
32How to Use
33
34Include ucdn.c, ucdn.h and unicodedata_db.h in your project. Now,
35just use the functions as documented in ucdn.h.
36
37In some cases, it might be necessary to regenerate the Unicode
38database file. The script makeunicodedata.py (Python 3.x required)
39fetches the appropriate files and dumps the compressed database into
40unicodedata_db.h.
41