[apple/icu.git] / icuSources / samples / coll / readme.txt

Copyright (C) 2016 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html#License

Copyright (c) 2002-2005, International Business Machines Corporation and others. All Rights Reserved.
coll: a sample program which compares 2 strings with a user-defined collator.

This sample demonstrates
         Creating a user-defined collator
         Comparing 2 string using the collator created
         
Files:
    coll.c                      Main source file
    coll.sln                    Windows MSVC workspace.  Double-click this to get started.
    coll.vcproj                 Windows MSVC project file

To Build coll on Windows
    1.  Install and build ICU
    2.  In MSVC, open the workspace file icu\samples\coll\coll.sln
    3.  Choose a Debug or Release build.
    4.  Build.
	
To Run on Windows
    1.  Start a command shell window
    2.  Add ICU's bin directory to the path, e.g.
            set PATH=c:\icu\bin;%PATH%
        (Use the path to where ever ICU is on your system.)
    3.  cd into the coll directory, e.g.
            cd c:\icu\source\samples\coll\debug
    4.  Run it
            coll [options*] -source source_string -target target_string

To Build on Unixes
    1.  Build ICU.  coll is built automatically by default unless samples are turned off.
        Specify an ICU install directory when running configure,
        using the --prefix option.  The steps to build ICU will look something
        like this:
           cd <icu directory>/source
           runConfigureICU <platform-name> --prefix <icu install directory> [other options]
           gmake all
           
    2.  Install ICU, 
           gmake install
           
 To Run on Unixes
           cd <icu directory>/source/samples/coll
           
           gmake check
               -or- 

           export LD_LIBRARY_PATH=<icu install directory>/lib:.:$LD_LIBRARY_PATH
           cal
           
           
 Note:  The name of the LD_LIBRARY_PATH variable is different on some systems.
        If in doubt, run the sample using "gmake check", and note the name of
        the variable that is used there.  LD_LIBRARY_PATH is the correct name
        for Linux and Solaris.
Commit	Line	Data
f3c0d7a5 A	1	Copyright (C) 2016 and later: Unicode, Inc. and others.
	2	License & terms of use: http://www.unicode.org/copyright.html#License
	3
73c04bcf	4	Copyright (c) 2002-2005, International Business Machines Corporation and others. All Rights Reserved.
b75a7d8f A	5	coll: a sample program which compares 2 strings with a user-defined collator.
	6
	7	This sample demonstrates
	8	Creating a user-defined collator
	9	Comparing 2 string using the collator created
	10
	11	Files:
	12	coll.c Main source file
73c04bcf A	13	coll.sln Windows MSVC workspace. Double-click this to get started.
73c04bcf A	14	coll.vcproj Windows MSVC project file
b75a7d8f A	15
	16	To Build coll on Windows
	17	1. Install and build ICU
73c04bcf	18	2. In MSVC, open the workspace file icu\samples\coll\coll.sln
b75a7d8f A	19	3. Choose a Debug or Release build.
	20	4. Build.
	21
	22	To Run on Windows
	23	1. Start a command shell window
	24	2. Add ICU's bin directory to the path, e.g.
	25	set PATH=c:\icu\bin;%PATH%
	26	(Use the path to where ever ICU is on your system.)
	27	3. cd into the coll directory, e.g.
	28	cd c:\icu\source\samples\coll\debug
	29	4. Run it
	30	coll [options*] -source source_string -target target_string
	31
	32	To Build on Unixes
	33	1. Build ICU. coll is built automatically by default unless samples are turned off.
	34	Specify an ICU install directory when running configure,
	35	using the --prefix option. The steps to build ICU will look something
	36	like this:
	37	cd <icu directory>/source
	38	runConfigureICU <platform-name> --prefix <icu install directory> [other options]
	39	gmake all
	40
	41	2. Install ICU,
	42	gmake install
	43
	44	To Run on Unixes
	45	cd <icu directory>/source/samples/coll
	46
	47	gmake check
	48	-or-
	49
	50	export LD_LIBRARY_PATH=<icu install directory>/lib:.:$LD_LIBRARY_PATH
	51	cal
	52
	53
	54	Note: The name of the LD_LIBRARY_PATH variable is different on some systems.
	55	If in doubt, run the sample using "gmake check", and note the name of
	56	the variable that is used there. LD_LIBRARY_PATH is the correct name
	57	for Linux and Solaris.
	58