text/dali/internal/libunibreak/README.md

   1 LIBUNIBREAK
   2 ===========
   3
   4 Overview
   5 --------
   6
   7 This is the README file for libunibreak, an implementation of the line
   8 breaking and word breaking algorithms as described in [Unicode Standard
   9 Annex 14] [1] and [Unicode Standard Annex 29] [2].  Check the project's
  10 [home page] [3] for up-to-date information.
  11
  12   [1]: http://www.unicode.org/reports/tr14/tr14-30.html
  13   [2]: http://www.unicode.org/reports/tr29/tr29-21.html
  14   [3]: https://github.com/adah1972/libunibreak
  15
  16
  17 Licence
  18 -------
  19
  20 This library is released under an open-source licence, the zlib/libpng
  21 licence.  Please check the file *LICENCE* for details.
  22
  23 Apart from using the algorithm, part of the code is derived from the
  24 [Unicode Public Data] [4], and the [Unicode Terms of Use] [5] may apply.
  25
  26   [4]: http://www.unicode.org/Public/
  27   [5]: http://www.unicode.org/copyright.html
  28
  29
  30 Installation
  31 ------------
  32
  33 There are three ways to build the library:
  34
  35 1. On \*NIX systems supported by the autoconfiscation tools, do the
  36    normal
  37
  38         ./configure
  39         make
  40         sudo make install
  41
  42    to build and install both the dynamic and static libraries.  In
  43    addition, one may
  44    - type `make doc` to generate the doxygen documentation; or
  45    - type `make linebreakdata` to regenerate *linebreakdata.c* from
  46      *LineBreak.txt*.
  47    - type `make wordbreakdata` to regenerate *wordbreakdata.c* from
  48      *WordBreakProperty.txt*.
  49
  50 2. On systems where GCC and Binutils are supported, one can type
  51
  52         cd src
  53         cp -p Makefile.gcc Makefile
  54         make
  55
  56    to build the static library.  In addition, one may
  57    - type `make debug` or `make release` to explicitly generate the
  58      debug or release build;
  59    - type `make doc` to generate the doxygen documentation; or
  60    - type `make linebreakdata` to regenerate *linebreakdata.c* from
  61      *LineBreak.txt*.
  62    - type `make wordbreakdata` to regenerate *wordbreakdata.c* from
  63      *WordBreakProperty.txt*.
  64
  65 3. On Windows, apart from using method 1 (Cygwin/MSYS) and method 2
  66    (MinGW), MSVC can also be used.  Type
  67
  68         cd src
  69         nmake -f Makefile.msvc
  70
  71    to build the static library.  By default the debug release is built.
  72    To build the release version
  73
  74         nmake -f Makefile.msvc CFG="libunibreak - Win32 Release"
  75
  76
  77 Documentation
  78 -------------
  79
  80 Check the generated document *doc/html/linebreak\_8h.html* and
  81 *doc/html/wordbreak\_8h.html* in the downloaded file for the public
  82 interfaces exposed to applications.
  83
  84
  85 <!--
  86 vim:autoindent:expandtab:formatoptions=tcqlmn:textwidth=72:
  87 -->