\bin\` to a location on the system PATH or to your application directory.
-**Building with other versions of Visual Studio Note:** The particular version of the MSVC compiler tool-set (and thus the corresponding version of Visual Studio) that is used to compile ICU is determined by the "PlatformToolset" property. This property is stored in two different shared files that are used to set common configuration settings amongst the various ICU "*.vcxproj" project files. For the non-UWP projects, this setting is in the shared file called "Build.Windows.ProjectConfiguration.props" located in the "allinone" directory. For the UWP projects, this setting is in the shared file called "Build.Windows.UWP.ProjectConfiguration.props", also located in the "allinone" directory.
-The value of v140 corresponds to the Visual Studio 2015 compiler tool set, whereas the value of v141 corresponds to the Visual Studio 2017 compiler tool set.
-In order to build the non-UWP projects with Visual Studio 2015 you will need to modify the file called "Build.Windows.ProjectConfiguration.props" to change the value of the PlatformToolset property. Note however that Visual Studio 2017 is required for building the UWP projects.
+#### Building with other versions of Visual Studio
-Please consider: Using older versions of the MSVC compiler is generally not recommended due to the improved support for the C++11 standard in newer versions of the compiler.
+The particular version of the MSVC compiler tool-set (and thus the corresponding version of Visual Studio) that is used to compile ICU is determined by the `PlatformToolset` property. This property is stored in two different shared files that are used to set common configuration settings amongst the various ICU `*.vcxproj` project files. For the non-UWP projects, this setting is in the shared file called `Build.Windows.ProjectConfiguration.props` located in the `allinone` directory. For the UWP projects, this setting is in the shared file called `Build.Windows.UWP.ProjectConfiguration.props`, also located in the `allinone` directory.
-**Re-targeting the Windows 10 SDK for the UWP projects Note:** If the version of the Windows 10 SDK that you have installed does not match the version used by the UWP projects, then you will need to "retarget" them to use the version of the SDK that you have installed instead. There are two ways to do this:
+The value of `v140` corresponds to the Visual Studio 2015 compiler tool set, whereas the value of `v141` corresponds to the Visual Studio 2017 compiler tool set.
-* In Visual Studio you can right-click on the UWP projects in the 'Solution Explorer' and select the option 'Retarget Projects' from the context menu. This will open up a window where you can select the SDK version to target from a drop-down list of the various SDKs that are installed on the machine.
-* Alternatively, you can manually edit the shared file called "Build.Windows.UWP.ProjectConfiguration.props" which is located in the "allinone" directory. You will need to change the of the "WindowsTargetPlatformVersion" property to the version of the SDK that you would like to use instead.
+In order to build the non-UWP projects with Visual Studio 2015 you will need to modify the file called `Build.Windows.ProjectConfiguration.props` to change the value of the `PlatformToolset` property. Note however that Visual Studio 2017 is required for building the UWP projects.
-**Using MSBUILD At The Command Line Note:** You can build ICU from the command line instead of using the Visual Studio GUI. Assuming that you have properly installed Visual Studio to support command line building, you should have a shortcut for the "Developer Command Prompt" listed in the Start Menu. (For Visual Studio 2017 you will need to install the "Desktop development with C++" option).
+> :point_right: **Note**: Using older versions of the MSVC compiler is generally not recommended due to the improved support for the C++11 standard in newer versions of the compiler.
-* Open the "Developer Command Prompt" shortcut from the Start Menu. (This will open up a new command line window).
-* From within the "Developer Command Prompt" change directory (cd) to the ICU source directory.
-* You can then use either 'msbuild' directly, or you can use the 'devenv.com' command to build ICU.
-* Using MSBUILD:
+#### Re-targeting the Windows 10 SDK for the UWP projects
-* To build the 32-bit Debug version, use the following command line:
- `'msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32'`.
-* To build the 64-bit Release version, use the following command line:
- `'msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64'`.
+If the version of the Windows 10 SDK that you have installed does not match the version used by the UWP projects, then you will need to "retarget" them to use the version of the SDK that you have installed instead. There are two ways to do this:
-* Using devenv.com:
+* In Visual Studio you can right-click on the UWP projects in the 'Solution Explorer' and select the option 'Retarget Projects' from the context menu. This will open up a window where you can select the SDK version to target from a drop-down list of the various SDKs that are installed on the machine.
+* Alternatively, you can manually edit the shared file called `Build.Windows.UWP.ProjectConfiguration.props` which is located in the `allinone` directory. You will need to change the of the `WindowsTargetPlatformVersion` property to the version of the SDK that you would like to use instead.
-* To build the 32-bit Debug version, use the following command line:
- `'devenv.com source\allinone\allinone.sln /build "Debug|Win32"'`.
-* To build the 64-bit Release version, use the following command line:
- `'devenv.com source\allinone\allinone.sln /build "Release|x64"'`.
+#### Using MSBUILD At The Command Line
-**Skipping the UWP Projects on the Command Line Note:** You can skip (or omit) building the UWP projects on the command line by passing the argument '`SkipUWP=true`' to either MSBUILD or devenv.
+You can build ICU from the command line instead of using the Visual Studio GUI. Assuming that you have properly installed Visual Studio to support command line building, you should have a shortcut for the "Developer Command Prompt" listed in the Start Menu. (For Visual Studio 2017 you will need to install the "Desktop development with C++" option).
-* For example, using MSBUILD:
+* Open the "Developer Command Prompt" shortcut from the Start Menu. (This will open up a new command line window).
+* From within the "Developer Command Prompt" change directory (`cd`) to the ICU source directory.
+* You can then use either `msbuild` directly, or you can use the `devenv.com` command to build ICU.
+* Using `MSBUILD`:
+ - To build the 32-bit Debug version, use the following command line:
+ ```
+ msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32
+ ```
+ - To build the 64-bit Release version, use the following command line:
+ ```
+ msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64
+ ```
+* Using `devenv.com`:
+ - To build the 32-bit Debug version, use the following command line:
+ ```
+ devenv.com source\allinone\allinone.sln /build "Debug|Win32"
+ ```
+ - To build the 64-bit Release version, use the following command line:
+ ```
+ devenv.com source\allinone\allinone.sln /build "Release|x64"
+ ```
-* To skip building the UWP projects with a 32-bit Debug build, use the following command line:
- `'msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32 /p:SkipUWP=true'`.
-* To skip building the UWP projects with a 64-bit Release version, use the following command line:
- `'msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64 /p:SkipUWP=true'`.
+#### Skipping the UWP Projects on the Command Line
-You can also use Cygwin with the MSVC compiler to build ICU, and you can refer to the [How To Build And Install On Windows with Cygwin](#HowToBuildCygwin) section for more details.
+You can skip (or omit) building the UWP projects on the command line by passing the argument '`SkipUWP=true`' to either MSBUILD or devenv.
-**Setting Active Platform Note:** Even though you are able to select "x64" as the active platform, if your operating system is not a 64 bit version of Windows, the build will fail. To set the active platform, two different possibilities are:
+* For example, using `MSBUILD`:
+ - To skip building the UWP projects with a 32-bit Debug build, use the following command line:
+ ```
+ msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32 /p:SkipUWP=true
+ ```
+ - To skip building the UWP projects with a 64-bit Release version, use the following command line:
+ ```
+ msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64 /p:SkipUWP=true
+ ```
-* Choose "Build" menu, select "Configuration Manager...", and select "Win32" or "x64" for the Active Platform Solution.
-* Another way is to select the desired build configuration from "Solution Platforms" dropdown menu from the standard toolbar. It will say "Win32" or "x64" in the dropdown list.
+You can also use Cygwin with the MSVC compiler to build ICU, and you can refer to the [How To Build And Install On Windows with Cygwin](#how-to-build-and-install-on-windows-with-cygwin) section for more details.
-**Setting Active Configuration Note:** To set the active configuration, two different possibilities are:
+#### Setting Active Platform
+
+Even though you are able to select "x64" as the active platform, if your operating system is not a 64 bit version of Windows, the build will fail. To set the active platform, two different possibilities are:
+
+* Choose "Build" menu, select "Configuration Manager...", and select "Win32" or "x64" for the Active Platform Solution.
+* Another way is to select the desired build configuration from "Solution Platforms" dropdown menu from the standard toolbar. It will say "Win32" or "x64" in the dropdown list.
+
+#### Setting Active Configuration
+
+To set the active configuration, two different possibilities are:
* Choose "Build" menu, select "Configuration Manager...", and select "Release" or "Debug" for the Active Configuration Solution.
* Another way is to select the desired build configuration from "Solution Configurations" dropdown menu from the standard toolbar. It will say "Release" or "Debug" in the dropdown list.
-**Batch Configuration Note:** If you want to build the Win32 and x64 platforms and Debug and Release configurations at the same time, choose "Build" menu, and select "Batch Build...". Click the "Select All" button, and then click the "Rebuild" button.
+#### Batch Configuration
-### [How To Build And Install On Windows with Cygwin](#HowToBuildCygwin)
+If you want to build the Win32 and x64 platforms and Debug and Release configurations at the same time, choose "Build" menu, and select "Batch Build...". Click the "Select All" button, and then click the "Rebuild" button.
+
+### How To Build And Install On Windows with Cygwin
Building International Components for Unicode with this configuration requires:
@@ -539,82 +575,113 @@ Building International Components for Unicode with this configuration requires:
* ranlib
* man (if you plan to look at the man pages)
-There are two ways you can build ICU with Cygwin. You can build with gcc or Microsoft Visual C++. If you use gcc, the resulting libraries and tools will depend on the Cygwin environment. If you use Microsoft Visual C++, the resulting libraries and tools do not depend on Cygwin and can be more easily distributed to other Windows computers (the generated man pages and shell scripts still need Cygwin). To build with gcc, please follow the "[How To Build And Install On UNIX](#HowToBuildUNIX)" instructions, while you are inside a Cygwin bash shell. To build with Microsoft Visual C++, please use the following instructions:
+There are two ways you can build ICU with Cygwin. You can build with gcc or Microsoft Visual C++. If you use gcc, the resulting libraries and tools will depend on the Cygwin environment. If you use Microsoft Visual C++, the resulting libraries and tools do not depend on Cygwin and can be more easily distributed to other Windows computers (the generated man pages and shell scripts still need Cygwin). To build with gcc, please follow the "[How To Build And Install On UNIX](#how-to-build-and-install-on-unix)" instructions, while you are inside a Cygwin bash shell. To build with Microsoft Visual C++, please use the following instructions:
1. Start the Windows "Command Prompt" window. This is different from the gcc build, which requires the Cygwin Bash command prompt. The Microsoft Visual C++ compiler will not work with a bash command prompt.
-2. If the computer isn't set up to use Visual C++ from the command line, you need to run vcvars32.bat.
- For example:
- "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\vcvars32.bat" can be used for 32-bit builds **or**
- "C:\Program Files (x86)\Microsoft Visual Studio 14\VC\bin\x86_amd64\vcvarsx86_amd64.bat" can be used for 64-bit builds on Windows x64.
+2. If the computer isn't set up to use Visual C++ from the command line, you need to run vcvars32.bat.
+ For example:
+ `C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\vcvars32.bat` can be used for 32-bit builds **or**
+ `C:\Program Files (x86)\Microsoft Visual Studio 14\VC\bin\x86_amd64\vcvarsx86_amd64.bat` can be used for 64-bit builds on Windows x64.
3. Unzip the icu-XXXX.zip file into any convenient location. Using command line zip, type "unzip -a icu-XXXX.zip -d drive:\directory", or just use WinZip.
4. Change directory to "icu/source", which is where you unzipped ICU.
-5. Run "bash [./runConfigureICU](source/runConfigureICU) Cygwin/MSVC" (See [Windows configuration note](#HowToWindowsConfigureICU) and non-functional configure options below).
-6. Type "make" to compile the libraries and all the data files. This make command should be GNU make.
-7. Optionally, type "make check" to run the test suite, which checks for ICU's functionality integrity (See [testing note](#HowToTestWithoutGmake) below).
-8. Type "make install" to install ICU. If you used the --prefix= option on configure or runConfigureICU, ICU will be installed to the directory you specified. (See [installation note](#HowToInstallICU) below).
+5. Run `bash ./runConfigureICU Cygwin/MSVC` (See [Windows configuration note](#setting-active-configuration) and non-functional configure options below; see source for [./runConfigureICU](https://github.com/unicode-org/icu/blob/master/icu4c/source/runConfigureICU)).
+6. Type `make` to compile the libraries and all the data files. This make command should be GNU make.
+7. Optionally, type `make check` to run the test suite, which checks for ICU's functionality integrity (See [testing note](#running-the-tests-from-the-command-line) below).
+8. Type `make install` to install ICU. If you used the `--prefix=` option on `configure` or `runConfigureICU`, ICU will be installed to the directory you specified. (See [installation note](#installing-icu) below).
-**Configuring ICU on Windows NOTE:**
+#### Configuring ICU on Windows
Ensure that the order of the PATH is MSVC, Cygwin, and then other PATHs. The configure script needs certain tools in Cygwin (e.g. grep).
-Also, you may need to run "dos2unix.exe" on all of the scripts (e.g. configure) in the top source directory of ICU. To avoid this issue, you can download the ICU source for Unix platforms (icu-xxx.tgz).
+Also, you may need to run `dos2unix.exe` on all of the scripts (e.g. `configure`) in the top source directory of ICU. To avoid this issue, you can download the ICU source for Unix platforms (icu-xxx.tgz).
-In addition to the Unix [configuration note](#HowToConfigureICU) the following configure options currently do not work on Windows with Microsoft's compiler. Some options can work by manually editing icu/source/common/unicode/pwin32.h, but manually editing the files is not recommended.
+In addition to the Unix [configuration note](#configuring-icu) the following configure options currently do not work on Windows with Microsoft's compiler. Some options can work by manually editing `icu/source/common/unicode/pwin32.h`, but manually editing the files is not recommended.
-* --disable-renaming
-* --enable-tracing
-* --enable-rpath
-* --enable-static (Requires that U_STATIC_IMPLEMENTATION be defined in user code that links against ICU's static libraries.)
-* --with-data-packaging=files (The pkgdata tool currently does not work in this mode. Manual packaging is required to use this mode.)
+* `--disable-renaming`
+* `--enable-tracing`
+* `--enable-rpath`
+* `--enable-static` (Requires that U_STATIC_IMPLEMENTATION be defined in user code that links against ICU's static libraries.)
+* `--with-data-packaging=files` (The pkgdata tool currently does not work in this mode. Manual packaging is required to use this mode.)
-### [How To Build And Install On UNIX](#HowToBuildUNIX)
+### How To Build And Install On UNIX
Building International Components for Unicode on UNIX requires:
* A C++ compiler installed on the target machine (for example: gcc, CC, xlC_r, aCC, cxx, etc...).
* An ANSI C compiler installed on the target machine (for example: cc).
* A recent version of GNU make (3.80+).
-* For a list of z/OS tools please view the [z/OS build section](#HowToBuildZOS) of this document for further details.
+* For a list of z/OS tools please view the [z/OS build section](#how-to-build-and-install-on-zos-os390) of this document for further details.
Here are the steps to build ICU:
-1. Decompress the icu-_X_._Y_.tgz (or icu-_X_._Y_.tar.gz) file. For example, gunzip -d < icu-_X_._Y_.tgz | tar xvf -
-2. Change directory to `icu/source`. cd icu/source
-3. Some files may have the wrong permissions.chmod +x runConfigureICU configure install-sh
-4. Run the [runConfigureICU](source/runConfigureICU) script for your platform. (See [configuration note](#HowToConfigureICU) below).
-5. Now build: gmake (or just `make` if GNU make is the default make on your platform) to compile the libraries and all the data files. The proper name of the GNU make command is printed at the end of the configuration run, as in "You must use gmake to compile ICU".
- Note that the compilation command output may be simplified on your platform. If this is the case, you will see just: gcc ... stubdata.c rather than gcc -DU_NO_DEFAULT_INCLUDE_UTF_HEADERS=1 -D_REENTRANT -I../common -DU_ATTRIBUTE_DEPRECATED= -O2 -Wall -std=c99 -pedantic -Wshadow -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -c -DPIC -fPIC -o stubdata.o stubdata.c
- If you need to see the whole compilation line, use "gmake VERBOSE=1". The full compilation line will print if an error occurs.
-6. Optionally,gmake check will run the test suite, which checks for ICU's functionality integrity (See [testing note](#HowToTestWithoutGmake) below).
-7. To install, gmake install to install ICU. If you used the --prefix= option on configure or runConfigureICU, ICU will be installed to the directory you specified. (See [installation note](#HowToInstallICU) below).
+1. Decompress the icu-_X_._Y_.tgz (or icu-_X_._Y_.tar.gz) file. For example,
+ ```
+ gunzip -d < icu-_X_._Y_.tgz | tar xvf -
+ ```
+1. Change directory to `icu/source`.
+ ```
+ cd icu/source
+ ```
+1. Some files may have the wrong permissions.
+ ```
+ chmod +x runConfigureICU configure install-sh
+ ```
+1. Run the [`runConfigureICU`](https://github.com/unicode-org/icu/blob/master/icu4c/source/runConfigureICU) script for your platform. (See [configuration note](#configuring-icu) below).
+1. Now build:
+```
+gmake
+```
+ (or just `make` if GNU make is the default make on your platform) to compile the libraries and all the data files. The proper name of the GNU make command is printed at the end of the configuration run, as in `"You must use gmake to compile ICU"`.
+ Note that the compilation command output may be simplified on your platform. If this is the case, you will see just: `gcc ... stubdata.c` rather than `gcc -DU_NO_DEFAULT_INCLUDE_UTF_HEADERS=1 -D_REENTRANT -I../common -DU_ATTRIBUTE_DEPRECATED= -O2 -Wall -std=c99 -pedantic -Wshadow -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -c -DPIC -fPIC -o stubdata.o stubdata.c`
+ If you need to see the whole compilation line, use `gmake VERBOSE=1`. The full compilation line will print if an error occurs.
+1. Optionally,
+```
+gmake check
+```
+ will run the test suite, which checks for ICU's functionality integrity (See [testing note](#running-the-tests-from-the-command-line) below).
+1. To install,
+```
+gmake install
+```
+ to install ICU. If you used the `--prefix=` option on `configure` or `runConfigureICU`, ICU will be installed to the directory you specified. (See [installation note](#installing-icu) below).
-**Configuring ICU NOTE:** Type "./runConfigureICU --help" for help on how to run it and a list of supported platforms. You may also want to type "./configure --help" to print the available configure options that you may want to give runConfigureICU. If you are not using the runConfigureICU script, or your platform is not supported by the script, you may need to set your CC, CXX, CFLAGS and CXXFLAGS environment variables, and type "./configure". HP-UX users, please see this [note regarding HP-UX multithreaded build issues](#ImportantNotesHPUX) with newer compilers. Solaris users, please see this [note regarding Solaris multithreaded build issues](#ImportantNotesSolaris).
+#### Configuring ICU
-ICU is built with strict compiler warnings enabled by default. If this causes excessive numbers of warnings on your platform, use the --disable-strict option to configure to reduce the warning level.
+Type `"./runConfigureICU --help"` for help on how to run it and a list of supported platforms. You may also want to type `"./configure --help"` to print the available configure options that you may want to give `runConfigureICU`. If you are not using the `runConfigureICU` script, or your platform is not supported by the script, you may need to set your `CC`, `CXX`, `CFLAGS` and `CXXFLAGS` environment variables, and type `"./configure"`. HP-UX users, please see this [note regarding HP-UX multithreaded build issues](#using-icu-in-a-multithreaded-environment-on-hp-ux) with newer compilers. Solaris users, please see this [note regarding Solaris multithreaded build issues](#linking-on-solaris).
-**Running The Tests From The Command Line NOTE:** You may have to set certain variables if you with to run test programs individually, that is apart from "gmake check". The environment variable **ICU_DATA** can be set to the full pathname of the data directory to indicate where the locale data files and conversion mapping tables are when you are not using the shared library (e.g. by using the .dat archive or the individual data files). The trailing "/" is required after the directory name (e.g. "$Root/source/data/out/" will work, but the value "$Root/source/data/out" is not acceptable). You do not need to set **ICU_DATA** if the complete shared data library is in your library path.
+ICU is built with strict compiler warnings enabled by default. If this causes excessive numbers of warnings on your platform, use the `--disable-strict` option to configure to reduce the warning level.
-**Installing ICU NOTE:** Some platforms use package management tools to control the installation and uninstallation of files on the system, as well as the integrity of the system configuration. You may want to check if ICU can be packaged for your package management tools by looking into the "packaging" directory. (Please note that if you are using a snapshot of ICU from Git, it is probable that the packaging scripts or related files are not up to date with the contents of ICU at this time, so use them with caution).
+#### Running The Tests From The Command Line
-### [How To Build And Install On z/OS (OS/390)](#HowToBuildZOS)
+You may have to set certain variables if you with to run test programs individually, that is apart from "gmake check". The environment variable **ICU_DATA** can be set to the full pathname of the data directory to indicate where the locale data files and conversion mapping tables are when you are not using the shared library (e.g. by using the .dat archive or the individual data files). The trailing "/" is required after the directory name (e.g. `$Root/source/data/out/` will work, but the value `$Root/source/data/out` is not acceptable). You do not need to set **ICU_DATA** if the complete shared data library is in your library path.
+
+#### Installing ICU
+
+Some platforms use package management tools to control the installation and uninstallation of files on the system, as well as the integrity of the system configuration. You may want to check if ICU can be packaged for your package management tools by looking into the `packaging` directory. (Please note that if you are using a snapshot of ICU from Git, it is probable that the packaging scripts or related files are not up to date with the contents of ICU at this time, so use them with caution).
+
+### How To Build And Install On z/OS (OS/390)
You can install ICU on z/OS or OS/390 (the previous name of z/OS), but IBM tests only the z/OS installation. You install ICU in a z/OS UNIX system services file system such as HFS or zFS. On this platform, it is important that you understand a few details:
* The makedep and GNU make tools are required for building ICU. If it is not already installed on your system, it is available at the [z/OS UNIX - Tools and Toys](http://www-03.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html) site. The PATH environment variable should be updated to contain the location of this executable prior to build. Failure to add these tools to your PATH will cause ICU build failures or cause pkgdata to fail to run.
* Since USS does not support using the mmap() function over NFS, it is recommended that you build ICU on a local filesystem. Once ICU has been built, you should not have this problem while using ICU when the data library has been built as a shared library, which is this is the default setting.
-* Encoding considerations: The source code assumes that it is compiled with codepage ibm-1047 (to be exact, the UNIX System Services variant of it). The pax command converts all of the source code files from ASCII to codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and must not be converted, or must be converted back to their original state. You can use the [unpax-icu.sh](as_is/os390/unpax-icu.sh) script to do this for you automatically. It will unpackage the tar file and convert all the necessary files for you automatically.
+* Encoding considerations: The source code assumes that it is compiled with codepage ibm-1047 (to be exact, the UNIX System Services variant of it). The pax command converts all of the source code files from ASCII to codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and must not be converted, or must be converted back to their original state. You can use the [unpax-icu.sh](https://github.com/unicode-org/icu/blob/master/icu4c/as_is/os390/unpax-icu.sh) script to do this for you automatically. It will unpackage the tar file and convert all the necessary files for you automatically.
* z/OS supports both native S/390 hexadecimal floating point and (with OS/390 2.6 and later) IEEE 754 binary floating point. This is a compile time option. Applications built with IEEE should use ICU DLLs that are built with IEEE (and vice versa). The environment variable IEEE390=0 will cause the z/OS version of ICU to be built without IEEE floating point support and use the native hexadecimal floating point. By default ICU is built with IEEE 754 support. Native floating point support is sufficient for codepage conversion, resource bundle and UnicodeString operations, but the Format APIs require IEEE binary floating point.
* z/OS introduced the concept of Extra Performance Linkage (XPLINK) to bring performance improvement opportunities to call-intensive C and C++ applications such as ICU. XPLINK is enabled on a DLL-by-DLL basis, so if you are considering using XPLINK in your application that uses ICU, you should consider building the XPLINK-enabled version of ICU. You need to set ICU's environment variable `OS390_XPLINK=1` prior to invoking the make process to produce binaries that are enabled for XPLINK. The XPLINK option, which is available for z/OS 1.2 and later, requires the PTF PQ69418 to build XPLINK enabled binaries.
* ICU requires XPLINK for the icuio library. If you want to use the rest of ICU without XPLINK, then you must use the --disable-icuio configure option.
* The latest versions of z/OS use [XPLINK version (C128) of the C++ standard library](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.2.0/com.ibm.zos.v2r2.cbcux01/oebind6.htm) by default. You may see [an error](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.2.0/com.ibm.zos.v2r2.cbcux01/oebind5.htm) when running with XPLINK disabled. To avoid this error, set the following environment variable or similar:
- export _CXX_PSYSIX="CEE.SCEELIB(C128N)":"CBC.SCLBSID(IOSTREAM,COMPLEX)"
+```
+export _CXX_PSYSIX="CEE.SCEELIB(C128N)":"CBC.SCLBSID(IOSTREAM,COMPLEX)"
+```
* When building ICU data, the heap size may need to be increased with the following environment variable:
- export _CEE_RUNOPTS="HEAPPOOLS(ON),HEAP(4M,1M,ANY,FREE,0K,4080)"
+```
+export _CEE_RUNOPTS="HEAPPOOLS(ON),HEAP(4M,1M,ANY,FREE,0K,4080)"
+```
-* The rest of the instructions for building and testing ICU on z/OS with UNIX System Services are the same as the [How To Build And Install On UNIX](#HowToBuildUNIX) section.
+* The rest of the instructions for building and testing ICU on z/OS with UNIX System Services are the same as the [How To Build And Install On UNIX](#how-to-build-and-install-on-unix) section.
#### z/OS (Batch/PDS) support outside the UNIX system services environment
@@ -628,53 +695,57 @@ A data set is roughly equivalent to a UNIX or Windows file. For most kinds of da
Here is an example of some environment variables that you can set prior to building ICU:
-OS390BATCH=1
+```
+OS390BATCH=1
LOADMOD=_USER_.ICU.LOAD
-LOADEXP=_USER_.ICU.EXP
-
+LOADEXP=_USER_.ICU.EXP
+```
The PDS member names for the DLL file names are as follows:
-IXMI_XX_IN --> libicui18n_XX_.dll
+```
+IXMI_XX_IN --> libicui18n_XX_.dll
IXMI_XX_UC --> libicuuc_XX_.dll
-IXMI_XX_DA --> libicudt_XX_e.dll
-
+IXMI_XX_DA --> libicudt_XX_e.dll
+```
You should point the LOADMOD environment variable at a partitioned data set extended (PDSE) and point the LOADEXP environment variable at a partitioned data set (PDS). The PDSE can be allocated with the following attributes:
-Data Set Name . . . : _USER_.ICU.LOAD
-Management class. . : _**None**_
-Storage class . . . : _BASE_
-Volume serial . . . : _TSO007_
-Device type . . . . : _3390_
-Data class. . . . . : _LOAD_
+```
+Data Set Name . . . : USER.ICU.LOAD
+Management class. . : **None**
+Storage class . . . : BASE
+Volume serial . . . : TSO007
+Device type . . . . : 3390
+Data class. . . . . : LOAD
Organization . . . : PO
Record format . . . : U
Record length . . . : 0
-Block size . . . . : _32760_
+Block size . . . . : 32760
1st extent cylinders: 1
Secondary cylinders : 5
-Data set name type : LIBRARY
-
+Data set name type : LIBRARY
+```
The PDS can be allocated with the following attributes:
-Data Set Name . . . : _USER_.ICU.EXP
-Management class. . : _**None**_
-Storage class . . . : _BASE_
-Volume serial . . . : _TSO007_
-Device type . . . . : _3390_
-Data class. . . . . : _**None**_
+```
+Data Set Name . . . : USER.ICU.EXP
+Management class. . : **None**
+Storage class . . . : BASE
+Volume serial . . . : TSO007
+Device type . . . . : 3390
+Data class. . . . . : **None**
Organization . . . : PO
Record format . . . : FB
Record length . . . : 80
-Block size . . . . : _3200_
+Block size . . . . : 3200
1st extent cylinders: 3
Secondary cylinders : 3
-Data set name type : PDS
-
+Data set name type : PDS
+```
-### [How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)](#HowToBuildOS400)
+### How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)
Before you start building ICU, ICU requires the following:
@@ -682,231 +753,120 @@ Before you start building ICU, ICU requires the following:
* ILE C/C++ Compiler installed on the system
* The latest IBM tools for Developers for IBM i — [https://www-356.ibm.com/partnerworld/wps/servlet/ContentHandler/pw_com_porting_tools_index](https://www-356.ibm.com/partnerworld/wps/servlet/ContentHandler/pw_com_porting_tools_index)
-The following describes how to setup and build ICU. For background information, you should look at the [UNIX build instructions](#HowToBuildUNIX).
+The following describes how to setup and build ICU. For background information, you should look at the [UNIX build instructions](#how-to-build-and-install-on-unix).
-1. Copy the ICU source .tgz to the IBM i environment, as binary. Also, copy the [unpax-icu.sh](as_is/os400/unpax-icu.sh) script into the same directory, as a text file.
+1. Copy the ICU source .tgz to the IBM i environment, as binary. Also, copy the [unpax-icu.sh](https://github.com/unicode-org/icu/blob/master/icu4c/as_is/os400/unpax-icu.sh) script into the same directory, as a text file.
2. Create target library. This library will be the target for the resulting modules, programs and service programs. You will specify this library on the OUTPUTDIR environment variable.
-
- CRTLIB LIB(_libraryname_)
- ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('_libraryname_') REPLACE(*YES)
-
+```
+CRTLIB LIB(_libraryname_)
+ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('_libraryname_') REPLACE(*YES)
+```
3. Set up the following environment variables and job characteristics in your build process
-
- ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
- CHGJOB CCSID(37)
-
+```
+ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
+CHGJOB CCSID(37)
+```
4. Fire up the QSH _(all subsequent commands are run inside the qsh session.)_
-
- qsh
-
+```
+qsh
+```
5. Set up the PATH:
-
- export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin
-
+```
+export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin
+```
6. Unpack the ICU source code archive:
-
- gzip -d icu-_X_._Y_.tgz
-
+```
+gzip -d icu-_X_._Y_.tgz
+```
7. Run unpax-icu.sh on the tar file generated from the previous step.
-
- unpax-icu.sh icu.tar
-
+```
+unpax-icu.sh icu.tar
+```
8. Build the program ICULD which ICU will use for linkage.
-
- cd icu/as_is/os400
- qsh bldiculd.sh
- cd ../../..
-
+```
+cd icu/as_is/os400
+qsh bldiculd.sh
+cd ../../..
+```
9. Change into the 'source' directory, and configure ICU. (See [configuration note](#HowToConfigureICU) for details). Note that --with-data-packaging=archive and setting the --prefix are recommended, building in default (dll) mode is currently not supported.
-
- cd icu/source
- ./runConfigureICU IBMi --prefix=_/path/to/somewhere_ --with-data-packaging=archive
-
-10. Build ICU. _(Note: Do not use the -j option)_
-
- gmake
-
+```
+cd icu/source
+./runConfigureICU IBMi --prefix=_/path/to/somewhere_ --with-data-packaging=archive
+```
+10. Build ICU.
+> :point_right: **Note**: Do not use the -j option
+```
+gmake
+```
11. Test ICU.
+```
+gmake check
+```
+(The `QIBM_MULTI_THREADED=Y` flag will be automatically applied to intltest - you can look at the [iSeries Information Center](https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahw/rzahwceeco.htm) for more details regarding the running of multiple threads on IBM i.)
- gmake check
-
- (The QIBM_MULTI_THREADED=Y flag will be automatically applied to intltest - you can look at the [iSeries Information Center](https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahw/rzahwceeco.htm) for more details regarding the running of multiple threads on IBM i.)
-
-### [How To Cross Compile ICU](#HowToCrossCompileICU)
+### How To Cross Compile ICU
This section will explain how to build ICU on one platform, but to produce binaries intended to run on another. This is commonly known as a cross compile.
-Normally, in the course of a build, ICU needs to run the tools that it builds in order to generate and package data and test-data.In a cross compilation setting, ICU is built on a different system from that which it eventually runs on. An example might be, if you are building for a small/headless system (such as an embedded device), or a system where you can't easily run the ICU command line tools (any non-UNIX-like system).
+Normally, in the course of a build, ICU needs to run the tools that it builds in order to generate and package data and test-data. In a cross compilation setting, ICU is built on a different system from that which it eventually runs on. An example might be, if you are building for a small/headless system (such as an embedded device), or a system where you can't easily run the ICU command line tools (any non-UNIX-like system).
-To reduce confusion, we will here refer to the "A" and the "B" system.System "A" is the actual system we will be running on- the only requirements on it is are it is able to build ICU from the command line targetting itself (with configure or runConfigureICU), and secondly, that it also contain the correct toolchain for compiling and linking for the resultant platform, referred to as the "B" system.
+To reduce confusion, we will here refer to the "A" and the "B" system. System "A" is the actual system we will be running on - the only requirements on it is are it is able to build ICU from the command line targetting itself (with `configure` or `runConfigureICU`), and secondly, that it also contain the correct toolchain for compiling and linking for the resultant platform, referred to as the "B" system.
The autoconf docs use the term "build" for A, and "host" for B. More details at: [http://www.gnu.org/software/autoconf/manual/html_node/Specifying-Names.html](http://www.gnu.org/software/autoconf/manual/html_node/Specifying-Names.html#Specifying-Names)
Three initially-empty directories will be used in this example:
-
+| **/icu** | a copy of the ICU source |
+| **/buildA** | an empty directory, it will contain ICU built for A (MacOSX in this case) |
+| **/buildB** | an empty directory, it will contain ICU built for B (HaikuOS in this case) |
-
+1. Check out or unpack the ICU source code into the `/icu` directory.You will have the directories `/icu/source`, etc.
+2. Build ICU in `/buildA` normally (using `runConfigureICU` or `configure`):
+```
+cd /buildA
+sh /icu/source/runConfigureICU MacOSX
+gnumake
+```
+3. Set `PATH` or other variables as needed, such as `CPPFLAGS`.
+4. Build ICU in `/buildB`
+```
+cd /buildB
+sh /icu/source/configure --host=i586-pc-haiku--with-cross-build=/buildA
+gnumake
+```
+> :point_right: **Note**: `--with-cross-build` takes an absolute path.
+5. Tests and testdata can be built with `gnumake tests`.
-
-
-| /icu |
-
-a copy of the ICU source |
-
-
-
-
-
-| /buildA |
-
-an empty directory, it will contain ICU built for A
-(MacOSX in this case) |
-
-
-
-
-
-| /buildB |
-
-an empty directory, it will contain ICU built for B
-(HaikuOS in this case) |
-
-
-
-
-
-
-
-1. Check out or unpack the ICU source code into the /icu directory.You will have the directories /icu/source, etc.
-2. Build ICU in /buildA normally (using runConfigureICU or configure):
-
- cd /buildA
- sh /icu/source/runConfigureICU **MacOSX**
- gnumake
-
-
-3. Set PATH or other variables as needed, such as CPPFLAGS.
-4. Build ICU in /buildB
-
- "`--with-cross-build`" takes an absolute path.
-
- cd /buildB
- sh /icu/source/configure --host=**i586-pc-haiku** --with-cross-build=**/buildA**
- gnumake
-
-5. Tests and testdata can be built with "gnumake tests".
-
-## [How To Package ICU](#HowToPackage)
+## How To Package ICU
There are many ways that a person can package ICU with their software products. Usually only the libraries need to be considered for packaging.
-On UNIX, you should use "gmake install" to make it easier to develop and package ICU. The bin, lib and include directories are needed to develop applications that use ICU. These directories will be created relative to the "--prefix=_dir_" configure option (See the [UNIX build instructions](#HowToBuildUNIX)). When ICU is built on Windows, a similar directory structure is built.
+On UNIX, you should use `gmake install` to make it easier to develop and package ICU. The bin, lib and include directories are needed to develop applications that use ICU. These directories will be created relative to the `--prefix=`dir" configure option (See the [UNIX build instructions](#how-to-build-and-install-on-unix)). When ICU is built on Windows, a similar directory structure is built.
When changes have been made to the standard ICU distribution, it is recommended that at least one of the following guidelines be followed for special packaging.
-1. Add a suffix name to the library names. This can be done with the --with-library-suffix configure option.
+1. Add a suffix name to the library names. This can be done with the `--with-library-suffix` configure option.
2. The installation script should install the ICU libraries into the application's directory.
Following these guidelines prevents other applications that use a standard ICU distribution from conflicting with any libraries that you need. On operating systems that do not have a standard C++ ABI (name mangling) for compilers, it is recommended to do this special packaging anyway. More details on customizing ICU are available in the [User's Guide](https://unicode-org.github.io/icu/userguide/). The [ICU Source Code Organization](#SourceCode) section of this readme.html gives a more complete description of the libraries.
-Here is an example of libraries that are frequently packaged.
+ICU has several libraries for you to use. Here is an example of libraries that are frequently packaged.
-
+| Library Name | Windows Filename | Linux Filename | Comment |
+|-------------------------------------|------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Data Library | icudtXYl.dll | libicudata.so.XY.Z | Data required by the Common and I18n libraries. There are many ways to package and [customize this data](https://unicode-org.github.io/icu/userguide/icudata), but by default this is all you need. |
+| Common Library | icuucXY.dll | libicuuc.so.XY.Z | Base library required by all other ICU libraries. |
+| Internationalization (i18n) Library | icuinXY.dll | libicui18n.so.XY.Z | A library that contains many locale based internationalization (i18n) functions. |
+| Layout Extensions Engine | iculxXY.dll | libiculx.so.XY.Z | An optional engine for doing paragraph layout that uses parts of ICU. HarfBuzz is required. |
+| ICU I/O (Unicode stdio) Library | icuioXY.dll | libicuio.so.XY.Z | An optional library that provides a stdio like API with Unicode support. |
+| Tool Utility Library | icutuXY.dll | libicutu.so.XY.Z | An internal library that contains internal APIs that are only used by ICU's tools. If you do not use ICU's tools, you do not need this library. |
-
-
-| Library Name |
-
-Windows Filename |
-
-Linux Filename |
-
-Comment |
-
-
-
-
-
-| Data Library |
-
-icudt_XY_l.dll |
-
-libicudata.so._XY_._Z_ |
-
-Data required by the Common and I18n libraries. There are many ways to package and [customize this data](https://unicode-org.github.io/icu/userguide/icudata), but by default this is all you need. |
-
-
-
-
-
-| Common Library |
-
-icuuc_XY_.dll |
-
-libicuuc.so._XY_._Z_ |
-
-Base library required by all other ICU libraries. |
-
-
-
-
-
-| Internationalization (i18n) Library |
-
-icuin_XY_.dll |
-
-libicui18n.so._XY_._Z_ |
-
-A library that contains many locale based internationalization (i18n) functions. |
-
-
-
-
-
-| Layout Extensions Engine |
-
-iculx_XY_.dll |
-
-libiculx.so._XY_._Z_ |
-
-An optional engine for doing paragraph layout that uses parts of ICU. HarfBuzz is required. |
-
-
-
-
-
-| ICU I/O (Unicode stdio) Library |
-
-icuio_XY_.dll |
-
-libicuio.so._XY_._Z_ |
-
-An optional library that provides a stdio like API with Unicode support. |
-
-
-
-
-
-| Tool Utility Library |
-
-icutu_XY_.dll |
-
-libicutu.so._XY_._Z_ |
-
-An internal library that contains internal APIs that are only used by ICU's tools. If you do not use ICU's tools, you do not need this library. |
-
-
-
-
-
-
Normally only the above ICU libraries need to be considered for packaging. The versionless symbolic links to these libraries are only needed for easier development. The _X_, _Y_ and _Z_ parts of the name are the version numbers of ICU. For example, ICU 2.0.2 would have the name libicuuc.so.20.2 for the common library. The exact format of the library names can vary between platforms due to how each platform can handles library versioning.
-## [Important Notes About Using ICU](#ImportantNotes)
+## Important Notes About Using ICU
-### [Using ICU in a Multithreaded Environment](#ImportantNotesMultithreaded)
+### Using ICU in a Multithreaded Environment
Some versions of ICU require calling the `u_init()` function from `uclean.h` to ensure that ICU is initialized properly. In those ICU versions, `u_init()` must be called before ICU is used from multiple threads. There is no harm in calling `u_init()` in a single-threaded application, on a single-CPU machine, or in other cases where `u_init()` is not required.
@@ -930,51 +890,53 @@ These ICU versions require a call to `u_init()` before multi-threaded use. The s
ICU 2.4 and earlier versions were not prepared for multithreaded use on multi-CPU platforms where the CPUs implement weak memory coherency. These CPUs include: Power4, Power5, Alpha, Itanium. `u_init()` was not defined yet.
-#### [Using ICU in a Multithreaded Environment on HP-UX](#ImportantNotesHPUX)
+#### Using ICU in a Multithreaded Environment on HP-UX
-When ICU is built with aCC on HP-UX, the [-AA](http://h21007.www2.hp.com/portal/site/dspp/menuitem.863c3e4cbcdc3f3515b49c108973a801?ciid=eb08b3f1eee02110b3f1eee02110275d6e10RCRD) compiler flag is used. It is required in order to use the latest API in a thread safe manner. This compiler flag affects the version of the C++ library being used. Your applications will also need to be compiled with -AA in order to use ICU.
+When ICU is built with aCC on HP-UX, the [`-AA`](http://h21007.www2.hp.com/portal/site/dspp/menuitem.863c3e4cbcdc3f3515b49c108973a801?ciid=eb08b3f1eee02110b3f1eee02110275d6e10RCRD) compiler flag is used. It is required in order to use the latest `` API in a thread safe manner. This compiler flag affects the version of the C++ library being used. Your applications will also need to be compiled with `-AA` in order to use ICU.
-#### [Using ICU in a Multithreaded Environment on Solaris](#ImportantNotesSolaris)
+#### Using ICU in a Multithreaded Environment on Solaris
##### Linking on Solaris
In order to avoid synchronization and threading issues, developers are **suggested** to strictly follow the compiling and linking guidelines for multithreaded applications, specified in the following SUn Solaris document available from Oracle. Most notably, pay strict attention to the following statements from Sun:
-> To use libthread, specify -lthread before -lc on the ld command line, or last on the cc command line.
->
-> To use libpthread, specify -lpthread before -lc on the ld command line, or last on the cc command line.
+> To use libthread, specify `-lthread` before `-lc` on the ld command line, or last on the cc command line.
+>
+> To use libpthread, specify `-lpthread` before `-lc` on the ld command line, or last on the cc command line.
Failure to do this may cause spurious lock conflicts, recursive mutex failure, and deadlock.
-Source: "_Multithreaded Programming Guide, Compiling and Debugging_", Sun Microsystems, 2002
+Source: "_Multithreaded Programming Guide, Compiling and Debugging_", Sun Microsystems, 2002
[https://docs.oracle.com/cd/E19683-01/806-6867/compile-74765/index.html](https://docs.oracle.com/cd/E19683-01/806-6867/compile-74765/index.html)
-Note, a version of that chapter from a 2008 document update covering both Solaris 9 and Solaris 10 is available here:
+Note, a version of that chapter from a 2008 document update covering both Solaris 9 and Solaris 10 is available here:
[http://docs.oracle.com/cd/E19253-01/816-5137/compile-94179/index.html](http://docs.oracle.com/cd/E19253-01/816-5137/compile-94179/index.html)
-### [Windows Platform](#ImportantNotesWindows)
+### Windows Platform
If you are building on the Windows platform, it is important that you understand a few of the following build details.
#### DLL directories and the PATH setting
-As delivered, the International Components for Unicode build as several DLLs, which are placed in the "__\bin64" directory. You must add this directory to the PATH environment variable in your system, or any executables you build will not be able to access International Components for Unicode libraries. Alternatively, you can copy the DLL files into a directory already in your PATH, but we do not recommend this. You can wind up with multiple copies of the DLL and wind up using the wrong one.
+As delivered, the International Components for Unicode build as several DLLs, which are placed in the `\bin64` directory. You must add this directory to the PATH environment variable in your system, or any executables you build will not be able to access International Components for Unicode libraries. Alternatively, you can copy the DLL files into a directory already in your PATH, but we do not recommend this. You can wind up with multiple copies of the DLL and wind up using the wrong one.
-#### Changing your PATH
+#### Changing your PATH
-**Windows 2000/XP and above**: Use the System Icon in the Control Panel. Pick the "Advanced" tab. Select the "Environment Variables..." button. Select the variable PATH in the lower box, and select the lower "Edit..." button. In the "Variable Value" box, append the string ";__\bin64" to the end of the path string. If there is nothing there, just type in "__\bin64". Click the Set button, then the OK button.
+##### Windows 2000/XP and above
-Note: When packaging a Windows application for distribution and installation on user systems, copies of the ICU DLLs should be included with the application, and installed for exclusive use by the application. This is the only way to insure that your application is running with the same version of ICU, built with exactly the same options, that you developed and tested with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the phrase "DLL hell" on [msdn.microsoft.com](http://msdn.microsoft.com/).
+Use the System Icon in the Control Panel. Pick the "Advanced" tab. Select the "Environment Variables..." button. Select the variable `PATH` in the lower box, and select the lower "Edit..." button. In the "Variable Value" box, append the string `;\bin64` to the end of the path string. If there is nothing there, just type in `\bin64`. Click the Set button, then the OK button.
-### [UNIX Type Platform](#ImportantNotesUNIX)
+> :point_right: **Note**: When packaging a Windows application for distribution and installation on user systems, copies of the ICU DLLs should be included with the application, and installed for exclusive use by the application. This is the only way to insure that your application is running with the same version of ICU, built with exactly the same options, that you developed and tested with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the phrase "DLL hell" on [msdn.microsoft.com](http://msdn.microsoft.com/).
-If you are building on a UNIX platform, and if you are installing ICU in a non-standard location, you may need to add the location of your ICU libraries to your **LD_LIBRARY_PATH** or **LIBPATH** environment variable (or the equivalent runtime library path environment variable for your system). The ICU libraries may not link or load properly without doing this.
+### UNIX Type Platform
-Note that if you do not want to have to set this variable, you may instead use the --enable-rpath option at configuration time. This option will instruct the linker to always look for the libraries where they are installed. You will need to use the appropriate linker options when linking your own applications and libraries against ICU, too. Please refer to your system's linker manual for information about runtime paths. The use of rpath also means that when building a new version of ICU you should not have an older version installed in the same place as the new version's installation directory, as the older libraries will used during the build, instead of the new ones, likely leading to an incorrectly build ICU. This is the proper behavior of rpath.
+If you are building on a UNIX platform, and if you are installing ICU in a non-standard location, you may need to add the location of your ICU libraries to your `LD_LIBRARY_PATH` or `LIBPATH` environment variable (or the equivalent runtime library path environment variable for your system). The ICU libraries may not link or load properly without doing this.
-## [Platform Dependencies](#PlatformDependencies)
+> :point_right: **Note**: If you do not want to have to set this variable, you may instead use the `--enable-rpath` option at configuration time. This option will instruct the linker to always look for the libraries where they are installed. You will need to use the appropriate linker options when linking your own applications and libraries against ICU, too. Please refer to your system's linker manual for information about runtime paths. The use of rpath also means that when building a new version of ICU you should not have an older version installed in the same place as the new version's installation directory, as the older libraries will used during the build, instead of the new ones, likely leading to an incorrectly build ICU. This is the proper behavior of rpath.
-### [Porting To A New Platform](#PlatformDependenciesNew)
+## Platform Dependencies
+
+### Porting To A New Platform
If you are using ICU's Makefiles to build ICU on a new platform, there are a few places where you will need to add or modify some files. If you need more help, you can always ask the [icu-support mailing list](http://site.icu-project.org/contacts). Once you have finished porting ICU to a new platform, it is recommended that you contribute your changes back to ICU via the icu-support mailing list. This will make it easier for everyone to benefit from your work.
@@ -990,41 +952,35 @@ ICU 3.6 removes the requirement that ICU be completely built in the native opera
#### Adapting Makefiles For a New Platform
-Try to follow the build steps from the [UNIX](#HowToBuildUNIX) build instructions. If the configure script fails, then you will need to modify some files. Here are the usual steps for porting to a new platform:
+Try to follow the build steps from the [UNIX](#how-to-build-and-install-on-unix) build instructions. If the configure script fails, then you will need to modify some files. Here are the usual steps for porting to a new platform:
-1. Create an mh file in icu/source/config/. You can use mh-linux or a similar mh file as your base configuration.
-2. Modify icu/source/aclocal.m4 to recognize your platform's mh file.
-3. Modify icu/source/configure.in to properly set your **platform** C Macro define.
-4. Run [autoconf](http://www.gnu.org/software/autoconf/) in icu/source/ without any options. The autoconf tool is standard on most Linux systems.
-5. If you have any optimization options that you want to normally use, you can modify icu/source/runConfigureICU to specify those options for your platform.
+1. Create an mh file in `/source/config/`. You can use mh-linux or a similar mh file as your base configuration.
+2. Modify `/source/aclocal.m4` to recognize your platform's mh file.
+3. Modify `/source/configure.in` to properly set your **platform** C Macro define.
+4. Run [autoconf](http://www.gnu.org/software/autoconf/) in `/source/` without any options. The autoconf tool is standard on most Linux systems.
+5. If you have any optimization options that you want to normally use, you can modify `/source/runConfigureICU` to specify those options for your platform.
6. Build and test ICU on your platform. It is very important that you run the tests. If you don't run the tests, there is no guarentee that you have properly ported ICU.
-### [Platform Dependent Implementations](#PlatformDependenciesImpl)
+### Platform Dependent Implementations
The platform dependencies have been mostly isolated into the following files in the common library. This information can be useful if you are porting ICU to a new platform.
-* **unicode/platform.h.in** (autoconf'ed platforms)
- **unicode/p_XXXX_.h** (others: pwin32.h, ppalmos.h, ..): Platform-dependent typedefs and defines:
-
- * Generic types like UBool, int8_t, int16_t, int32_t, int64_t, uint64_t etc.
- * U_EXPORT and U_IMPORT for specifying dynamic library import and export
- * String handling support for the char16_t and wchar_t types.
-
-* **unicode/putil.h, putil.c**: platform-dependent implementations of various functions that are platform dependent:
-
- * uprv_isNaN, uprv_isInfinite, uprv_getNaN and uprv_getInfinity for handling special floating point values.
- * uprv_tzset, uprv_timezone, uprv_tzname and time for getting platform specific time and time zone information.
- * u_getDataDirectory for getting the default data directory.
- * uprv_getDefaultLocaleID for getting the default locale setting.
- * uprv_getDefaultCodepage for getting the default codepage encoding.
-
-* **umutex.h, umutex.c**: Code for doing synchronization in multithreaded applications. If you wish to use International Components for Unicode in a multithreaded application, you must provide a synchronization primitive that the classes can use to protect their global data against simultaneous modifications. We already supply working implementations for many platforms that ICU builds on.
-
-* **umapfile.h, umapfile.c**: functions for mapping or otherwise reading or loading files into memory. All access by ICU to data from files makes use of these functions.
-
-* Using platform specific #ifdef macros are highly discouraged outside of the scope of these files. When the source code gets updated in the future, these #ifdef's can cause testing problems for your platform.
+* **unicode/platform.h.in** (autoconf'ed platforms)
+ **unicode/p_XXXX_.h** (others: pwin32.h, ppalmos.h, ..): Platform-dependent typedefs and defines:
+ * Generic types like `UBool`, `int8_t`, `int16_t`, `int32_t`, `int64_t`, `uint64_t` etc.
+ * `U_EXPORT` and `U_IMPORT` for specifying dynamic library import and export
+ * String handling support for the `char16_t` and `wchar_t` types.
+* **unicode/putil.h, putil.c**: platform-dependent implementations of various functions that are platform dependent:
+ * `uprv_isNaN`, `uprv_isInfinite`, `uprv_getNaN` and `uprv_getInfinity` for handling special floating point values.
+ * `uprv_tzset`, `uprv_timezone`, `uprv_tzname` and `time` for getting platform specific time and time zone information.
+ * `u_getDataDirectory` for getting the default data directory.
+ * `uprv_getDefaultLocaleID` for getting the default locale setting.
+ * `uprv_getDefaultCodepage` for getting the default codepage encoding.
+* **umutex.h, umutex.c**: Code for doing synchronization in multithreaded applications. If you wish to use International Components for Unicode in a multithreaded application, you must provide a synchronization primitive that the classes can use to protect their global data against simultaneous modifications. We already supply working implementations for many platforms that ICU builds on.
+* **umapfile.h, umapfile.c**: functions for mapping or otherwise reading or loading files into memory. All access by ICU to data from files makes use of these functions.
+* Using platform specific `#ifdef` macros are highly discouraged outside of the scope of these files. When the source code gets updated in the future, these `#ifdef`'s can cause testing problems for your platform.
* * *
-Copyright © 2016 and later: Unicode, Inc. and others. License & terms of use: [http://www.unicode.org/copyright.html](http://www.unicode.org/copyright.html)
+Copyright © 2016 and later: Unicode, Inc. and others. License & terms of use: [http://www.unicode.org/copyright.html](http://www.unicode.org/copyright.html)
Copyright © 1997-2016 International Business Machines Corporation and others. All Rights Reserved.
diff --git a/docs/userguide/icu4j-readme.md b/docs/userguide/icu4j-readme.md
new file mode 100644
index 00000000000..54c740a76e2
--- /dev/null
+++ b/docs/userguide/icu4j-readme.md
@@ -0,0 +1,454 @@
+---
+layout: default
+title: ICU4J Readme
+nav_order: 8
+parent: ICU
+---
+
+
+# ICU4J Readme
+{: .no_toc }
+
+## Contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Introduction to ICU4J
+
+The International Components for Unicode (ICU) library provides robust and full-featured Unicode services on a wide variety of platforms. ICU supports the most current version of the Unicode standard, including support for supplementary characters (needed for GB 18030 repertoire support).
+
+Java provides a strong foundation for global programs, and IBM and the ICU team played a key role in providing globalization technology to Java. But because of its long release schedule, Java cannot always keep up with evolving standards. The ICU team continues to extend Java's Unicode and internationalization support, focusing on improving performance, keeping current with the Unicode standard, and providing richer APIs, while remaining as compatible as possible with the original Java text and internationalization API design.
+
+ICU4J is an add-on to the regular JRE that provides:
+
+* [Collation](https://unicode-org.github.io/icu/userguide/collation) – rule-based, up-to-date Unicode Collation Algorithm (UCA) sorting order
+ For fast multilingual string comparison; faster and more complete than the J2SE implementation
+* [Charset Detection](https://unicode-org.github.io/icu/userguide/conversion/detection) – Recognition of various single and multibyte charsets
+ Useful for recognizing untagged text data
+* [UnicodeSet](https://unicode-org.github.io/icu/userguide/strings/unicodeset) – standard set operations optimized for sets of Unicode characters
+ UnicodeSets can be built from string patterns using any Unicode properties.
+* [Transforms](https://unicode-org.github.io/icu/userguide/transforms) – a flexible mechanism for Unicode text conversions
+ Including Full/Halfwidth conversions, Normalization, Case conversions, Hex conversions, and transliterations between scripts (50+ pairs)
+* [Unicode Normalization](https://unicode-org.github.io/icu/userguide/transforms/normalization) – NFC, NFD, NFKD, NFKC
+ For canonical text representations, needed for XML and the net
+* [International Calendars](https://unicode-org.github.io/icu/userguide/datetime/calendar) – Arabic, Buddhist, Chinese, Hebrew, Japanese, Ethiopic, Islamic, Coptic and other calendars
+ Required for correct presentation of dates in certain countries
+* [Date Format Enhancements](https://unicode-org.github.io/icu/userguide/format_parse/datetime) – Date/time pattern generator, Relative date formatting, etc.
+ Enhancements to the normal Java date formatting.
+* [Number Format Enhancements](https://unicode-org.github.io/icu/userguide/format_parse/numbers) – Scientific Notation, Spelled-out, Compact decimal format, etc.
+ Enhancements to the normal Java number formatting. The spell-out format is used for checks and similar documents
+* [Enhanced Word-Break Detection](https://unicode-org.github.io/icu/userguide/boundaryanalysis) – Rule-based, supports Thai, Khmer, Chinese, etc.
+ Required for correct support of Thai
+* [Unicode Text Compression](https://unicode-org.github.io/icu/userguide/conversion/compression) – Standard compression of Unicode text
+ Suitable for large numbers of small fields, where LZW and similar schemes do not apply
+* [Charset Conversion](https://unicode-org.github.io/icu/userguide/conversion) – Conversion to and from different charsets.
+ Plugs into Java CharsetProvider Service Provider Interface (SPI)
+
+> :point_right: **Note:** We continue to provide assistance to Java, and in some cases, ICU4J support has been rolled into a later release of Java. For example, BCP47 language tag support including Unicode locale extensions is now in Java 7\. However, the most current and complete version is always found in ICU4J.
+
+## What Is New In The Current Release?
+
+See the [ICU download page](http://site.icu-project.org/download/) to find the subpage for the current release, including any other changes, bug fixes, known issues, changes to supported platforms and build environments, and migration issues for existing applications migrating from previous ICU releases.
+
+The subpage for the current release will also include an API Change Report, both for ICU4C and ICU4J, for a complete list of APIs added, removed, or changed in this release.
+
+The list of API changes since the previous ICU4J release is available [here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/unicode-org/icu/master/icu4j/APIChangeReport.html).
+
+Changes in previous releases can also be found the main [ICU download page](http://site.icu-project.org/download) in its version-specific subpages.
+
+## License Information
+
+The ICU projects (ICU4C and ICU4J) are hosted by the [Unicode Consortium](http://www.unicode.org/). The ICU binary and source files are distributed under the [UNICODE DATA FILES AND SOFTWARE LICENSE](http://www.unicode.org/copyright.html). The full copy of the license and third party software licenses are available in [LICENSE](https://github.com/unicode-org/icu/blob/master/icu4j/main/shared/licenses/LICENSE) file included in this package.
+
+## Platform Dependencies
+
+The minimum Java runtime version supported by ICU4J 68 is version 7\. Java runtime version 6 is not supported.
+
+ICU4J since version 63 depend on J2SE 7 functionality. Therefore, ICU4J only runs on JRE version 7 or later. ICU4J 68 is tested on JRE 7, 8, 9, 10 and 11.
+
+## How to Download ICU4J
+
+There are a few different ways to download the ICU4J releases.
+
+* **Official Release:**
+ If you want to use ICU4J (as opposed to developing it), your best bet is to download an official, packaged version of the ICU4J library files. These versions are tested more thoroughly than day-to-day development builds, and they are packaged in jar files for convenient download.
+ * [ICU Download page](http://www.icu-project.org/download/)
+ * Maven repository:
+
+~~~
+
+ com.ibm.icu
+ icu4j
+ 68.1
+
+
+
+ com.ibm.icu
+ icu4j-charset
+ 68.1
+
+
+
+ com.ibm.icu
+ icu4j-localespi
+ 68.1
+
+~~~
+
+* **GitHub Source Repository:**
+ If you are interested in developing features, patches, or bug fixes for ICU4J, you should probably be working with the latest version of the ICU4J source code. You will need to clone and checkout the code from our GitHub repository to ensure that you have the most recent version of all of the files. There are several ways to do this. Please follow the directions that are contained on the [Source Repository page](http://www.icu-project.org/repository/) for details.
+
+For more details on how to download ICU4J directly from the web site, please see the ICU download page at [http://www.icu-project.org/download/](http://www.icu-project.org/download/)
+
+## The Structure and Contents of ICU4J
+
+Below, all directory paths are relative to the directory where the ICU4J source archive is extracted.
+
+### Information and build files
+
+| Path | Description |
+|------------------------------|-----------------------------------------------------------------------------------------|
+| readme.html | A description of ICU4J (International Components for Unicode for Java) |
+| build.html | The main Ant build file for ICU4J. See [How to Install and Build](#how-to-install-and-build) for more information |
+| main/shared/licenses/LICENSE | ICU license |
+
+### ICU4J runtime class files
+
+| Path | Sub-component Name | Build Dependencies | Public API Packages | Description |
+|-------------------------|--------------------|---------------------------|---------------------|---------------|
+| `main/classes/charset` | `icu4j-charset` | `icu4j-core` | `com.ibm.icu.charset` | Implementation of `java.nio.charset.spi.CharsetProvider`. This sub-component is shipped as `icu4j-charset.jar` along with ICU charset converter data files. |
+| `main/classes/collate` | `icu4j-collate` | `icu4j-core` | `com.ibm.icu.text`
`com.ibm.icu.util` | Collator APIs and implementation. Also includes some public API classes that depend on Collator. This sub-component is packaged as a part of `icu4j.jar`. |
+| `main/classes/core` | `icu4j-core` | n/a | `com.ibm.icu.lang`
`com.ibm.icu.math`
`com.ibm.icu.text`
`com.ibm.icu.util` | ICU core API classes and implementation. This sub-component is packaged as a part of `icu4j.jar`. |
+| `main/classes/currdata` | `icu4j-currdata` | `icu4j-core` | n/a | No public API classes. Provides access to currency display data. This sub-component is packaged as a part of `icu4j.jar`. |
+| `main/classes/langdata` | `icu4j-langdata` | `icu4j-core` | n/a | No public API classes. Provides access to language display data. This sub-component is packaged as a part of `icu4j.jar`. |
+| `main/classes/localespi` | `icu4j-localespi` | `icu4j-core`
`icu4j-collate` | n/a | Implementation of various locale-sensitive service providers defined in `java.text.spi` and `java.util.spi` in J2SE 6.0 or later Java releases. This sub-component is shipped as `icu4j-localespi.jar`. |
+| `main/classes/regiondata` | `icu4j-regiondata` | `icu4j-core` | n/a | No public API classes. Provides access to region display data. This sub-component is packaged as a part of `icu4j.jar`. |
+| `main/classes/translit` | `icu4j-translit` | `icu4j-core` | `com.ibm.icu.text` | Transliterator APIs and implementation. This sub-component is packaged as a part of `icu4j.jar`. |
+
+### ICU4J unit test files
+
+| Path | Sub-component Name | Runtime Dependencies | Description |
+|-------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
+| `main/tests/charset` | `icu4j-charset-tests` | `icu4j-charset`
`icu4j-core`
`icu4j-test-framework` | Test suite for charset sub-component. |
+| `main/tests/collate` | `icu4j-collate-tests` | `icu4j-collate`
`icu4j-core`
`icu4j-test-framework` | Test suite for collate sub-component. |
+| `main/tests/core` | `icu4j-core-tests` | `icu4j-core`
`icu4j-currdata`
`icu4j-langdata`
`icu4j-regiondata`
`icu4j-test-framework` | Test suite for core sub-component. |
+| `main/tests/framework` | `icu4j-test-framework` | `icu4j-core` | Common ICU4J unit test framework and utilities. |
+| `main/tests/localespi` | `icu4j-localespi-tests` | `icu4j-core`
`icu4j-collate`
`icu4j-currdata`
`icu4j-langdata`
`icu4j-localespi`
`icu4j-regiondata`
`icu4j-test-framework` | Test suite for localespi sub-component. |
+| `main/tests/packaging` | `icu4j-packaging-tests` | `icu4j-core`
`icu4j-test-framework` | Test suite for sub-component packaging. |
+| `main/tests/translit` | `icu4j-translit-tests` | `icu4j-core`
`icu4j-translit`
`icu4j-test-framework` | Test suite for translit sub-component. |
+
+
+
+
+### Others
+
+
+
+ | Path |
+ Description |
+
+
+ main/shared |
+ Files shared by ICU4J sub-components under the main directory including: - ICU4J runtime data archive (icudata.jar).
- ICU4J unit test data archive (testdata.jar).
- Shared Ant build script and configuration files.
- License files.
|
+
+
+ demos |
+ ICU4J demo programs. |
+
+
+ perf-tests |
+ ICU4J performance test files. |
+
+
+ tools |
+ ICU4J tools including: - Custom JavaDoc taglets used for generating ICU4J API references.
- API report tool and data.
- Other independent utilities used for ICU4J development.
|
+
+
+ lib |
+ Folder used for downloading depedency libraries.
Note: ICU4J runtime libraries do not depend on any external libraries other than JDK. These dependencies are for testing (such as JUnit). |
+
+
+
+## Where to get Documentation
+
+The [ICU user's guide](https://unicode-org.github.io/icu/userguide/) contains lots of general information about ICU, in its C, C++, and Java incarnations.
+
+The complete API documentation for ICU4J (javadoc) is available on the ICU4J web site, and can be built from the sources:
+
+* [Index to all ICU4J API](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/)
+* [Charset Detector](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/CharsetDetector.html) – Detection of charset from a byte stream
+* International Calendars – [Buddhist](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/BuddhistCalendar.html), [Chinese](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/ChineseCalendar.html), [Coptic](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/CopticCalendar.html), [Ethiopic](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/EthiopicCalendar.html), [Gregorian](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/GregorianCalendar.html), [Hebrew](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/HebrewCalendar.html), [Indian](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/IndianCalendar.html), [Islamic](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/IslamicCalendar.html), [Japanese](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/JapaneseCalendar.html), Persian, Dangi.
+* Time Zone Enhancements – [Time zone transition and rule detection](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/BasicTimeZone.html), [iCalendar VTIMEZONE formatting and parsing](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/VTimeZone.html), [Custom time zones constructed by user defined rules](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/RuleBasedTimeZone.html).
+* Date Format Enhancements – [Date/Time Pattern Generator](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/DateTimePatternGenerator.html), [Date Interval Format](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/DateIntervalFormat.html), [Duration Format](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/DurationFormat.html).
+* [Unicode Normalization](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/Normalizer.html) – Canonical text representation for W3C.
+* [Number Format Enhancements](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/NumberFormat.html) – Scientific Notation, Spelled out.
+* [Enhanced word-break detection](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/BreakIterator.html) – Rule-based, supports Thai
+* [Transliteration](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/Transliterator.html) – A general framework for converting text from one format to another, e.g. Cyrillic to Latin, or Hex to Unicode.
+* Unicode Text [Compression](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/UnicodeCompressor.html) & [Decompression](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/UnicodeDecompressor.html) – 2:1 compression on English Unicode text.
+* Collation – [Rule-based sorting](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/RuleBasedCollator.html), [Efficient multi-lingual searching](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/StringSearch.html), [Alphabetic indexing](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/AlphabeticIndex.html)
+
+## How to Install and Build
+
+To install ICU4J, simply place the pre-built jar file `icu4j.jar` on your Java `CLASSPATH`. If you need Charset API support please also place `icu4j-charset.jar` on your class path along with `icu4j.jar`.
+
+To build ICU4J, you will need JDK 7 or later (JDK 8 is the reference environment for this release) and the Apache Ant version 1.9 or later. It's recommended to install both the JDK and Ant somewhere _outside_the ICU4J directory. For example, on Linux you might install these in `/usr/local`.
+
+* Install JDK 8.
+* Install the [Apache Ant](https://ant.apache.org/) 1.9 or later.
+* Set environment variables `JAVA_HOME`, `ANT_HOME` and `PATH`, for example:
+
+~~~
+set JAVA_HOME=C:\jdk1.8.0
+set ANT_HOME=C:\apache-ant
+set PATH=%JAVA_HOME%\bin;%ANT_HOME%\bin;%PATH%
+~~~
+
+Once the JDK and Ant are configured, run the desired target defined in `build.xml`. The default target is `jar` which compiles ICU4J library class files and create ICU4J jar files. For example:
+
+~~~
+C:\icu4j>ant
+Buildfile: C:\icu4j\build.xml
+
+info:
+ [echo] ----- Build Environment Information -------------------
+ [echo] Java Home: C:\jdk1.8.0\jre
+ [echo] Java Version: 1.8.0_181
+ [echo] Ant Home: C:\apache-ant
+ [echo] Ant Version: Apache Ant(TM) version 1.10.1 compiled on February 2 2017
+ [echo] OS: Windows 10
+ [echo] OS Version: 10.0
+ [echo] OS Arch: amd64
+ [echo] Host: ICUDEV
+ [echo] -------------------------------------------------------
+
+core:
+
+@compile:
+ [echo] build-local: ../../shared/../../build-local.properties
+ [echo] --- java compiler arguments ------------------------
+ [echo] source dir: C:\icu4j\main\classes\core/src
+ [echo] output dir: C:\icu4j\main\classes\core/out/bin
+ [echo] bootclasspath:
+ [echo] classpath:
+ [echo] source: 1.7
+ [echo] target: 1.7
+ [echo] debug: on
+ [echo] encoding: UTF-8
+ [echo] compiler arg: -Xlint:all,-deprecation,-dep-ann,-options,-overrides
+ [echo] ----------------------------------------------------
+ [mkdir] Created dir: C:\icu4j\main\classes\core\out\bin
+ [javac] Compiling 470 source files to C:\icu4j\main\classes\core\out\bin
+ [javac] Note: Some input files use or override a deprecated API.
+ [javac] Note: Recompile with -Xlint:deprecation for details.
+
+compile:
+
+@copy:
+ [copy] Copying 24 files to C:\icu4j\main\classes\core\out\bin
+
+set-icuconfig-datapath:
+
+copy-data:
+ [unjar] Expanding: C:\icu4j\main\shared\data\icudata.jar into C:\icu4j\main\
+classes\core\out\bin
+ [unjar] Expanding: C:\icu4j\main\shared\data\icutzdata.jar into C:\icu4j\mai
+n\classes\core\out\bin
+
+...
+...
+...
+
+localespi:
+
+@compile:
+ [echo] build-local: ../../shared/../../build-local.properties
+ [echo] --- java compiler arguments ------------------------
+ [echo] source dir: C:\icu4j\main\classes\localespi/src
+ [echo] output dir: C:\icu4j\main\classes\localespi/out/bin
+ [echo] bootclasspath:
+ [echo] classpath: C:\icu4j\main\classes\core\out\lib\icu4j-core.jar;C:
+\icu4j\main\classes\collate\out\lib\icu4j-collate.jar
+ [echo] source: 1.7
+ [echo] target: 1.7
+ [echo] debug: on
+ [echo] encoding: UTF-8
+ [echo] compiler arg: -Xlint:all,-deprecation,-dep-ann,-options
+ [echo] ----------------------------------------------------
+ [mkdir] Created dir: C:\icu4j\main\classes\localespi\out\bin
+ [javac] Compiling 22 source files to C:\icu4j\main\classes\localespi\out\bin
+
+compile:
+
+@copy:
+ [copy] Copying 11 files to C:\icu4j\main\classes\localespi\out\bin
+
+copy:
+
+@jar:
+ [mkdir] Created dir: C:\icu4j\main\classes\localespi\out\lib
+ [copy] Copying 1 file to C:\icu4j\main\classes\localespi\out
+ [jar] Building jar: C:\icu4j\main\classes\localespi\out\lib\icu4j-localesp
+i.jar
+
+jar:
+
+@src-jar:
+ [jar] Building jar: C:\icu4j\main\classes\localespi\out\lib\icu4j-localesp
+i-src.jar
+
+src-jar:
+
+build:
+
+jar:
+ [copy] Copying 1 file to C:\icu4j
+ [copy] Copying 1 file to C:\icu4j
+
+BUILD SUCCESSFUL
+Total time: 30 seconds
+~~~
+
+> :point_right: **Note**: The above output is an example. The numbers are likely to be different with the current version ICU4J.
+
+The following are some targets that you can provide to `ant`. For more targets run `ant -projecthelp` or see the build.xml file.
+
+
+
+
+
+| **jar (default)** | Create ICU4J runtime library jar archives (`icu4j.jar`, `icu4j-charset.jar` and `icu4j-localespi.jar`) in the root ICU4J directory. |
+| **check** | Build all ICU4J runtime library classes and corresponding unit test cases, then run the tests. |
+| **clean** | Remove all build output files. |
+| **main** | Build all ICU4J runtime library sub-components (under the directory `main/classes`). |
+| **tests** | Build all ICU4J unit test sub-components (under the directory `main/tests`) and their dependencies. |
+| **tools** | Build the tools. |
+| **docs** | Run javadoc over the ICU4J runtime library files, generating an HTML documentation tree in the subdirectory `doc`. |
+| **jarDocs** | Create ICU4J doc jar archive (`icu4jdocs.jar`) containing API reference docs in the root ICU4J directory. |
+| **jarDemos** | Create ICU4J demo jar archive (`icu4jdemos.jar`) in the root ICU4J directory. |
+
+For more information, read the Ant documentation and the **build.xml** file.
+
+> :point_right: **Note**: If you get an OutOfMemoryError when you are running "ant check", you can set the heap size of the jvm by setting the environment variable JVM_OPTIONS to the appropriate java options.
+
+> :point_right: **Note**: **Eclipse users:** See the ICU4J site for information on [how to configure Eclipse](http://site.icu-project.org/setup/eclipse) to build and develop ICU4J on Eclipse IDE.
+
+> :point_right: **Note**: To install and configure ICU4J Locale Service Provider, please refer the user guide page [ICU4J Locale Service Provider](https://unicode-org.github.io/icu/userguide/icu4j-locale-service-provider).
+
+## Trying Out ICU4J
+
+> :point_right: **Note**: the demos provided with ICU4J are for the most part undocumented. This list can show you where to look, but you'll have to experiment a bit. The demos are **unsupported** and may change or disappear without notice.
+
+The icu4j.jar file contains only the ICU4J runtime library classes, not the demo classes, so unless you build ICU4J there is little to try out.
+
+### Charset
+
+To try out the **Charset** package, build **icu4j.jar** and **icu4j-charset.jar** using the `jar` target. You can use the charsets by placing these files on your classpath.
+
+~~~
+java -cp $icu4j_root/icu4j.jar:$icu4j_root/icu4j-charset.jar
+~~~
+
+### Other demos
+
+The other demo programs are **not supported** and exist only to let you experiment with the ICU4J classes. First, build ICU4J using `ant jarDemos`. Then launch the demos as below:
+
+~~~
+java -jar $icu4j_root/icu4jdemos.jar
+~~~
+
+## ICU4J Resource Information
+
+Starting with release 2.1, ICU4J includes its own resource information which is completely independent of the JRE resource information. (Note, ICU4J 2.8 to 3.4, time zone information depends on the underlying JRE). The ICU4J resource information is equivalent to the information in ICU4C and many resources are, in fact, the same binary files that ICU4C uses.
+
+By default the ICU4J distribution includes all of the standard resource information. It is located under the directory com/ibm/icu/impl/data. Depending on the service, the data is in different locations and in different formats.
+
+> :point_right: **Note**: This will continue to change from release to release, so clients should not depend on the exact organization of the data in ICU4J.
+
+* The primary **locale data** is under the directory `icudt68b`, as a set of `".res"` files whose names are the locale identifiers. Locale naming is documented the `com.ibm.icu.util.ULocale` class, and the use of these names in searching for resources is documented in `com.ibm.icu.util.UResourceBundle`.
+* The **break iterator data** is under the directory `icudt68b/brkitr`, as a set of `".res"`, `".brk"` and `".dict"` files.
+* The **collation data** is under the directory `icudt68b/coll`, as a set of `".res"` files.
+* The **currency display name data** is under the directory `icudt68b/curr`, as a set of `".res"` files.
+* The **language display name data** is under the directory `icudt68b/lang`, as a set of `".res"` files.
+* The **rule-based number format data** is under the directory `icudt68b/rbnf`, as a set of `".res"` files.
+* The **region display name data** is under the directory `icudt68b/region`, as a set of `".res"` files.
+* The **rule-based transliterator data** is under the directory `icudt68b/translit`, as a set of `".res"` files.
+* The **measurement unit data** is under the directory `icudt68b/unit`, as a set of `".res"` files.
+* The **time zone display name data** is under the directory `icudt68b/zone`, as a set of `".res"` files.
+* The **character property data** and default **unicode collation algorithm (UCA) data** is found under the directory `icudt68b`, as a set of `".icu"` files.
+* The **normalization data** is found under the directory `icudt68b`, as a set of `".nrm"` files.
+* The **character set converter data** is under the directory `icudt68b`, as a set of `".cnv"` files. These files are currently included only in icu-charset.jar.
+* The **time zone rule data** is under the directory `icudt68b`, as `zoneinfo64.res`.
+* The **holiday data** is under the directory `icudt68b`, as a set of `".class"` files, named `"HolidayBundle_"` followed by the locale ID.
+
+Some of the data files alias or otherwise reference data from other data files. One reason for this is because some locale names have changed. For example, `he_IL` used to be `iw_IL`. In order to support both names but not duplicate the data, one of the resource files refers to the other file's data. In other cases, a file may alias a portion of another file's data in order to save space. Currently ICU4J provides no tool for revealing these dependencies.
+
+> :point_right: **Note**: Java's `Locale` class silently converts the language code `"he"` to `"iw"` when you construct the Locale (for versions of Java through Java 5). Thus Java cannot be used to locate resources that use the `"he"` language code. ICU, on the other hand, does not perform this conversion in ULocale, and instead uses aliasing in the locale data to represent the same set of data under different locale ids.
+
+Resource files that use locale ids form a hierarchy, with up to four levels: a root, language, region (country), and variant. Searches for locale data attempt to match as far down the hierarchy as possible, for example, `"he_IL"` will match `he_IL`, but `"he_US"` will match `he` (since there is no `US` variant for he, and `"xx_YY` will match root (the default fallback locale) since there is no `xx` language code in the locale hierarchy. Again, see `java.util.ResourceBundle` for more information.
+
+**Currently ICU4J provides no tool for revealing these dependencies** between data files, so trimming the data directly in the ICU4J project is a hit-or-miss affair. The key point when you remove data is to make sure to remove all dependencies on that data as well. For example, if you remove `he.res`, you need to remove `he_IL.res`, since it is lower in the hierarchy, and you must remove iw.res, since it references `he.res`, and `iw_IL.res`, since it depends on it (and also references `he_IL.res`).
+
+Unfortunately, the jar tool in the JDK provides no way to remove items from a jar file. Thus you have to extract the resources, remove the ones you don't want, and then create a new jar file with the remaining resources. See the jar tool information for how to do this. Before 'rejaring' the files, be sure to thoroughly test your application with the remaining resources, making sure each required resource is present.
+
+### Using additional resource files with ICU4J
+
+> :warning: **Warning: Resource file formats can change across releases of ICU4J!**
+>
+> The format of ICU4J resources is not part of the API. Clients who develop their own resources for use with ICU4J should be prepared to regenerate them when they move to new releases of ICU4J.
+
+
+We are still developing ICU4J's resource mechanism. Currently it is not possible to mix icu's new binary `.res` resources with traditional java-style `.class` or `.txt` resources. We might allow for this in a future release, but since the resource data and format is not formally supported, you run the risk of incompatibilities with future releases of ICU4J.
+
+Resource data in ICU4J is checked in to the repository as a jar file containing the resource binaries, `$icu4j_root/main/shared/data/icudata.jar`. This means that inspecting the contents of these resources is difficult. They currently are compiled from ICU4C `.txt` file data. You can view the contents of the ICU4C text resource files to understand the contents of the ICU4J resources.
+
+The files in `icudata.jar` get extracted to `com/ibm/icu/impl/data` in the build output directory by some build targets.
+
+### Building ICU4J Resources from ICU4C
+
+ICU4J data is built by ICU4C tools. Please see [`icu4j-readme.txt`](https://github.com/unicode-org/icu/blob/master/icu4c/source/data/icu4j-readme.txt) in `icu4c/source/data` for the procedures.
+
+#### Generating Data from CLDR
+
+> :point_right: **Note**: This procedure assumes that all 3 sources are present
+
+> :point_right: **Note**: The following example was written using the example of the CLDR 38 release which was released in conjunction with the ICU 68.1 release
+
+1. Checkout or download CLDR version `release-38`
+2. Checkout ICU with tag `release-68-1`
+3. cd to icu4c/source/data directory
+4. Follow the instructions in [`icu4c/source/data/cldr-icu-readme.txt`](https://github.com/unicode-org/icu/blob/master/icu4c/source/data/cldr-icu-readme.txt)
+5. Rebuild ICU4C with the newly generated data.
+6. Run ICU4C tests to verify that the new data is good.
+7. Build ICU4J data from ICU4C data by following the procedures in [`icu4j/source/data/icu4j-readme.txt`](https://github.com/unicode-org/icu/blob/master/icu4c/source/data/icu4j-readme.txt)
+8. cd to `icu4j` dir
+9. Build and test icu4j
+
+## About ICU4J Time Zone
+
+ICU4J library includes the latest time zone data, as of the release date. However, time zone data is frequently updated in response to changes made by local governments around the world. If you need to update the time zone data, please refer the ICU user guide topic [Updating the Time Zone Data](https://unicode-org.github.io/icu/userguide/datetime/timezone#updating-the-time-zone-data).
+
+You can optionally configure ICU4J date and time service classes to use underlying JDK TimeZone implementation (see the ICU4J API reference [TimeZone](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/TimeZone.html) for the details). When this configuration is enabled, ICU's own time zone data won't be used and you have to get time zone data patches from the JRE vendor.
+
+## Where to Find More Information
+
+[http://www.icu-project.org/](http://www.icu-project.org/) is the home page of International Components for Unicode development project
+
+## Submitting Comments, Requesting Features and Reporting Bugs
+
+Your comments are important to making ICU4J successful. We are committed to investigate any bug reports or suggestions, and will use your feedback to help plan future releases.
+
+To submit comments, request features and report bugs, please see [ICU bug database information](http://site.icu-project.org/bugs) or contact us through the [ICU Support mailing list](http://site.icu-project.org/contacts). While we are not able to respond individually to each comment, we do review all comments.
+
+## Thank you for your interest in ICU4J!
+
+* * *
+
+© 2016 and later: Unicode, Inc. and others.
+License & terms of use: [http://www.unicode.org/copyright.html](http://www.unicode.org/copyright.html)
\ No newline at end of file