From 5020de1f617a6b7fffc5714d87c2f9dfcc9ac013 Mon Sep 17 00:00:00 2001 From: Yoshito Umaoka Date: Thu, 29 Sep 2016 19:51:52 +0000 Subject: [PATCH] ICU-12739 Updated readme.html. Removed platform support table and module support section, revised some descriptions, mentioned development hosting and licensing change and other minor updates. X-SVN-Rev: 39400 --- icu4j/readme.html | 267 ++++++++++++---------------------------------- 1 file changed, 67 insertions(+), 200 deletions(-) diff --git a/icu4j/readme.html b/icu4j/readme.html index 1bfb1434808..c0b4edada5c 100644 --- a/icu4j/readme.html +++ b/icu4j/readme.html @@ -7,30 +7,30 @@ ReadMe for ICU4J

International Components for Unicode for Java (ICU4J)

-

Read Me for ICU4J 58 Milestone 1

-(Last Update: 2016-July-1) +

Read Me for ICU4J Release Candidate

+(Last Update: 2016-Sep-29)

-Note: This is a development release of ICU4J 58. + +Note: This is a release candidate of ICU4J 58. The contents of this document may not reflect the recent changes done for ICU 58 development. This release candidate is intended for those wishing to verify ICU 58 integration before final release. It is not -recommended for production use. --> +recommended for production use.

For the most recent release, see the ICU4J @@ -106,13 +106,13 @@ certain countries

  • Number Format -Enhancements – Scientific Notation, Spelled-out, etc.
    +Enhancements – 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 – Rule-based, supports Thai
    +Word-Break Detection – Rule-based, supports Thai, Khmer, Chinese, etc.
        Required for correct support of Thai
  • Unicode @@ -142,6 +142,13 @@ The list of API changes since the previous ICU4J release is available here.

    +

    ICU development and license change

    +The Unicode® Consortium hosts development of the ICU libraries starting from this relase. +The ICU Project Management Committee is now a Unicode Technical Committee, the ICU-TC. +ICU will continue to be released under a similar open source license. +For more details, see the Unicode announcement. + + @@ -160,136 +167,9 @@ file included in this package.

    ICU4J 58 depends on J2SE 6 functionality. Therefore, ICU4J only runs on JRE version 6 or later. -The table below shows the operating systems and JRE/VM versions currently -used by the ICU development team to test ICU4J. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Operating SystemJRE 8JRE 7JRE 6
    32bit64bit32bit64bit32bit64bit
    AIX 6.1---Regularly tested-Regularly tested
    AIX 7.1---Reference platform-Regularly tested
    HP-UX 11 (IA64)---Regularly tested-Regularly tested
    Mac OS X 10.6-----Regularly tested
    Redhat Enterprise Linux 6 (x86)--Regularly tested-Regularly tested-
    Redhat Enterprise Linux 6 (x86_64)-Regularly tested-Reference platform-Regularly tested
    Solaris 10 (SPARC)--Regularly testedRegularly testedRegularly testedRegularly tested
    Solaris 11 (SPARC)---Regularly tested-Regularly tested
    Windows XP--Regularly tested-Regularly tested-
    Windows Vista--Regularly tested-Regularly tested-
    Windows 7-Regularly testedReference platform-Regularly tested-
    Windows 2008 Server-Regularly tested-Regularly tested-Regularly tested

    How to Download ICU4J

    -

    There are two ways to download the ICU4J releases. +

    There are a few different ways to download the ICU4J releases.

    • Official Release:
      @@ -297,9 +177,18 @@ 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. -These packaged files can be found at the -ICU Download page. -
    +
      +
    • ICU Download page.
      • +
    • Maven repository: +
      +<dependency>
+    <groupId>com.ibm.icu</groupId>
+    <artifactId>icu4j</artifactId>
+    <version>58.1</version>
+</dependency>
+
      +
    +
    • Subversion Source Repository:
      If you are interested in developing features, patches, or bug fixes for @@ -603,47 +492,38 @@ 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 J2SE SDK 6 or later and the Ant build system -version 1.8 or later. It's recommended to install both the J2SE SDK and Ant +To build ICU4J, you will need JDK 7 or later (JDK 8 is the reference envionment for this release) +and the Apache Ant version 1.9 or later. It's recommended to install both the JDK and Ant somewhere outsidethe ICU4J directory. For example, on Linux you might install these in /usr/local.

        -
      • Install J2SE SDK 7.
        • -
      • Install the Ant - build system. Ant is a portable, Java-based build system similar to - make. ICU4J uses Ant because it introduces no other dependencies, it's - portable, and it's easier to manage than a collection of makefiles. We - currently build ICU4J using a single makefile on all platforms Ant. - The build system requires Ant 1.7 or later. -

        Installing Ant is straightforward. Download it (see http://ant.apache.org/bindownload.cgi), -extract it onto your system, set some environment variables, and add -its bin directory to your path. For example:

        +
      • Install JDK 8.
        • +
      • Install the Apache Ant + 1.9 or later. +
      • Set environment variables JAVA_HOME, ANT_HOME and PATH, for example: 
        -        set JAVA_HOME=C:\jdk1.7.0
-        set ANT_HOME=C:\ant
+        set JAVA_HOME=C:\jdk1.8.0
+        set ANT_HOME=C:\apache-ant
         set PATH=%JAVA_HOME%\bin;%ANT_HOME%\bin;%PATH%
        -

        See the current Ant documentation for details.

        +
      -

      Once the J2SE SDK and Ant are installed, building is just a matter of -typing ant in the ICU4J root directory. This causes the -Ant build system to perform the build target jar -as specified by the file build.xml, located in the ICU4J -root directory. You can give Ant options like -verbose, and you can specify -other targets. For example:

      +

      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.7.0\jre
-     [echo] Java Version: 1.7.0
-     [echo] Ant Home:     C:\ant
+     [echo] Java Home:    C:\jdk1.8.0\jre
+     [echo] Java Version: 1.8.0_102
+     [echo] Ant Home:     C:\apache-ant
      [echo] Ant Version:  Apache Ant(TM) version 1.9.4 compiled on April 29 2014
-     [echo] OS:           Windows 7
-     [echo] OS Version:   6.1
+
+     [echo] OS:           Windows 10
+     [echo] OS Version:   10.0
      [echo] OS Arch:      amd64
      [echo] Host:         ICUDEV
      [echo] -------------------------------------------------------
@@ -652,20 +532,20 @@ core:
 
 @compile:
      [echo] build-local:     ../../shared/../../build-local.properties
-     [echo] ${java5.bootclasspath}
      [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.5
-     [echo] target:         1.5
+     [echo] bootclasspath:
+     [echo] classpath:
+     [echo] source:         1.6
+     [echo] target:         1.6
      [echo] debug:          on
      [echo] encoding:       UTF-8
-     [echo] compiler arg:   -Xlint:all,-deprecation,-dep-ann,-options
+     [echo] compiler arg:   -Xlint:all,-deprecation,-dep-ann,-options,-overrides
+
      [echo] ----------------------------------------------------
     [mkdir] Created dir: C:\icu4j\main\classes\core\out\bin
-    [javac] Compiling 365 source files to C:\icu4j\main\classes\core\out\bin
+    [javac] Compiling 364 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.
 
@@ -690,10 +570,10 @@ _build-localespi:
 
 @compile:
      [echo] build-local:     ../../shared/../../build-local.properties
-     [echo] ${java5.bootclasspath}
      [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.6
@@ -734,7 +614,7 @@ jar:
      [copy] Copying 1 file to C:\icu4j
 
 BUILD SUCCESSFUL
-Total time: 50 seconds
      +Total time: 30 seconds
      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. @@ -800,14 +680,6 @@ how to configure Eclipse to build and develop ICU4J on Eclipse IDE.

      page ICU4J Locale Service Provider.

      -

      How to modularize ICU4J

      -

      Some clients may not wish to ship all of ICU4J with their -application, since the application might only use a small part of ICU4J. -ICU4J release 2.6 and later provide build options to build individual -ICU4J 'modules' for a more compact distribution. For more details, please -refer to the section Modularization of ICU4J in the ICU user's -guide article Packaging ICU4J. -

      Trying Out ICU4J

      Note: the demos provided with ICU4J are for the most part undocumented. This list can show you where to look, but @@ -816,12 +688,12 @@ 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

      +

      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 <your program>
      -

      Other demos

      +

      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:

      @@ -943,7 +815,7 @@ resources. See the jar tool information for how to do this. Before the remaining resources, making sure each required resource is present.

      -

      Using additional resource files with ICU4J

      +

      Using additional resource files with ICU4J

      @@ -983,14 +855,14 @@ 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

      +

      Building ICU4J Resources from ICU4C

      ICU4J data is built by ICU4C tools. Please see "icu4j-readme.txt" in $icu4c_root/source/data for the procedures.
      Generating Data from CLDR
      Note: This procedure assumes that all 3 sources are present
      1. Checkout or download CLDR version 'release-30'
        2. -
      2. Checkout ICU4C with tag 'release-58-rc'
        3. -
      3. Checkout ICU4J with tag 'release-58-rc'
        4. +
      4. Checkout ICU4C with tag 'release-58-1'
        5. +
      5. Checkout ICU4J with tag 'release-58-1'
      6. cd to $icu4c_root/source/data directory
      7. Follow the instructions in $icu4c_root/source/data/cldr-icu-readme.txt
      8. Rebuild ICU4C with the newly generated data.
        9. @@ -1002,12 +874,12 @@ ICU4J data is built by ICU4C tools. Please see "icu4j-readme.txt" in $icu4c_r

      About ICU4J Time Zone

      -

      ICU4J 58 Milestone 1 includes time zone data version 2016e, which is the latest one as of -the release date. However, time zone data is frequently updated in response +

      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.

      -

      Starting with ICU4J 4.0, you can optionally configure ICU4J date and time +

      You can optionally configure ICU4J date and time service classes to use underlying JDK TimeZone implementation (see the ICU4J API reference TimeZone for the details). When this configuration is enabled, ICU's own time zone data @@ -1017,12 +889,7 @@ won't be used and you have to get time zone data patches from the JRE vendor.

      http://www.icu-project.org/ is the home page of International Components for Unicode development project

      -

      http://www.ibm.com/software/globalization/icu/ -is a pointer to general information about the International Components for -Unicode hosted by IBM

      -

      http://www.ibm.com/software/globalization/ -is a pointer to -information on how to make applications global.

      +

      Submitting Comments, Requesting Features and Reporting Bugs

      -- 2.40.0