icuSources/samples/readme.txt

   1 ## Copyright (c) 2002-2003, International Business Machines Corporation
   2 ## and others. All Rights Reserved.
   3
   4 This directory contains sample code
   5 Below is a short description of the contents of this directory.
   6
   7 break - demonstrates how to use BreakIterators in C and C++.
   8
   9 cal      - prints out a calendar.
  10
  11 case    - demonstrates how to do Unicode case conversion in C and C++.
  12
  13 date     - prints out the current date, localized.
  14
  15 datefmt  - an exercise using the date formatting API
  16
  17 layout   - demonstrates the ICU LayoutEngine
  18
  19 legacy   - demonstrates using two versions of ICU in one application
  20
  21 msgfmt   - demonstrates the use of the Message Format
  22
  23 numfmt   - demonstrates the use of the number format
  24
  25 props    - demonstrates the use of Unicode properties
  26
  27 strsrch - demonstrates how to search for patterns in Unicode text using the usearch interface.
  28
  29 translit - demonstrates the use of ICU transliteration
  30
  31 uciter8.c - demonstrates how to leniently read 8-bit Unicode text.
  32
  33 ucnv     - demonstrates the use of ICU codepage conversion
  34
  35 udata    - demonstrates the use of ICU low level data routines
  36
  37 ufortune - demonstrates packaging and use of resources in an application
  38
  39 ugrep  - demonstrates ICU Regular Expressions.
  40
  41 uresb    - demonstrates building and loading resource bundles
  42
  43 ustring  - demonstrates ICU string manipulation functions
  44
  45
  46 ==
  47 * Where can I find more sample code?
  48
  49  - The "uconv" utility is a full-featured command line application.
  50     It is normally built with ICU, and is located in icu/source/extra/uconv
  51
  52  - The "icuapps" CVS module contains other applications and libraries not
  53     included with ICU.  You can check it out from the CVS command line
  54     by using for example,  "cvs co icuapps" instead of "cvs co icu",
  55    or through WebCVS at http://oss.software.ibm.com/cvs/icu/icuapps/
  56
  57 ==
  58 * How do I build the samples?
  59
  60  - See the Readme in each subdirectory
  61
  62  To build all samples at once:
  63
  64     Unix:   - build and install (make install) ICU
  65             - be sure 'icu-config' is accessible from the PATH
  66             - type 'make all-samples' from this directory
  67                (other targets:  clean-samples, check-samples)
  68            Note: 'make all-samples' won't work correctly in out of source builds.
  69
  70             - legacy and layout are not included in these lists,
  71                    please see their individual readmes.