src/hb-ucdn/README

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