src/hb-ucdn/README

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