• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1## Copyright (C) 2016 and later: Unicode, Inc. and others.
2## License & terms of use: http://www.unicode.org/copyright.html
3##
4## Copyright (c) 2002-2010, International Business Machines Corporation
5## and others. All Rights Reserved.
6
7This directory contains sample code using ICU4C routines. Below is a
8short description of the contents of this directory.
9
10break   - demonstrates how to use BreakIterators in C and C++.
11
12cal     - prints out a calendar.
13
14case    - demonstrates how to do Unicode case conversion in C and C++.
15
16coll    - shows how collation compares strings
17
18csdet   -  demonstrates using ICU's CharSet Detection API
19
20date    - prints out the current date, localized.
21
22datecal - demonstrates how a calendar object provides information
23
24datefmt - an exercise using the date formatting API
25
26dtitvfmtsample - shows how date interval format uses predefined skeletons
27
28dtptngsample - uses DateTimePatternGenerator to create customized date/time pattern
29
30layout   - demonstrates the ICU LayoutEngine (obsolete)
31
32legacy   - demonstrates using two versions of ICU in one application (obsolete)
33
34msgfmt   - demonstrates the use of the Message Format
35
36numfmt   - demonstrates the use of the number format
37
38plurfmtsample - uses PluralFormat and Messageformat to get Plural Form
39
40props    - demonstrates the use of Unicode properties
41
42strsrch - demonstrates how to search for patterns in Unicode text using the usearch interface.
43
44translit - demonstrates the use of ICU transliteration
45
46uciter8 - demonstrates how to leniently read 8-bit Unicode text.
47
48ucnv     - demonstrates the use of ICU codepage conversion
49
50udata    - demonstrates the use of ICU low level data routines (reader/writer in 'all' MSVC solution)
51
52ufortune - demonstrates packaging and use of resources in an application
53
54ugrep    - demonstrates ICU Regular Expressions.
55
56uresb    - demonstrates building and loading resource bundles
57
58ustring  - demonstrates ICU string manipulation functions
59
60
61==
62* Where can I find more sample code?
63
64 - The "uconv" utility is a full-featured command line application.
65   It is normally built with ICU, and is located in icu/source/extra/uconv
66
67 - The "icu-demos" contains other applications and libraries not
68   included with ICU.  You can check it out from https://github.com/unicode-org/icu-demos
69   using github clone. See the README file for additional information.
70
71==
72* How do I build the samples?
73
74 - See the Readme in each subdirectory
75
76 To build all samples at once:
77
78    Windows MSVC:
79            - build ICU
80	    - open 'all' project file in 'all' subdirectory
81            - build project
82            - sample executables will be located in /x86/Debug folders of each sample subdirectory
83
84    Unix:   - build and install (make install) ICU
85            - be sure 'icu-config' is accessible from the PATH
86            - type 'make all-samples' from this directory
87               (other targets:  clean-samples, check-samples)
88      Note: 'make all-samples' won't work correctly in out of source builds.
89
90      Note that legacy and layout are obsolete samples that may not compile or run without
91            adjustments to their makefiles.
92