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