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