Update and flesh out WinCVS instructions, jakarta-ant setup instructions, and add a note about the data files

X-SVN-Rev: 2472
This commit is contained in:
Alan Liu 2000-09-21 21:49:12 +00:00
parent 2713a561fa
commit fb5bafafe6

View file

@ -10,7 +10,7 @@
<h2>ReadMe: International Components for Unicode for Java</h2>
<p>Version: April 13, 2000 </p>
<p>Version: September 21, 2000 </p>
<hr size="2" width="100%" align="center">
@ -92,15 +92,22 @@ Contains</u></h3>
your own machine so that you can do batch operations without going through the WebCVS
interface. On Windows, we suggest the WinCVS client. The following is the example
instruction on how to download ICU4J via WinCVS: <ol>
<li>Install the WinCVS client, which you can download from the WinCVS home page.</li>
<li>In the WinCVS preferences, specify your CVSRoot to be
&quot;:pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j&quot; <br>
with the password &quot;anoncvs&quot;. To enter the CVSRoot value, select
&quot;Preferences&quot; from the &quot;Cvs Admin&quot; pull-down menu.&nbsp;&nbsp;&nbsp;
Authentication should be set to &quot;'passwd' file on the cvs server&quot;.</li>
<li>To &quot;extract&quot; the most recent version of ICU4J, select &quot;Checkout
module&quot; from the &quot;Cvs Admin&quot; menu. Specify &quot;icu4j&quot; for the module
name. <br>
<li>Install the WinCVS client, which you can download from the <a
href="http://www.wincvs.org">http://www.wincvs.org</a>.</li>
<li>Select <strong>Preferences</strong> from the <strong>Admin</strong> menu.<ol type="a">
<li>On the <strong>General</strong> tab panel: Set your <strong>CVSROOT</strong> to &quot;<strong>:pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j</strong>&quot;.
Set <strong>Authentication</strong> to &quot;<strong>'passwd' file on the cvs server</strong>&quot;.
Leave other options on this page at their default.</li>
<li>On the <strong>Ports</strong> tab panel: Check the <strong>pserver</strong> checkbox and
enter port <strong>2401</strong>.</li>
</ol>
</li>
<li>Login (<strong>Admin</strong> menu) with the password &quot;<strong>anoncvs</strong>&quot;.</li>
<li>To extract the most recent version of ICU4J, select <strong>Checkout module</strong>
from the <strong>Create</strong> menu. Specify &quot;<strong>icu4j</strong>&quot; for the
module name. This will create a new copy of the workspace on your local hard drive.</li>
<li>In the future, you can download updated files from the repository to your hard drive
using the <strong>Update selection</strong> item in the <strong>Modify</strong> menu.<br>
</li>
</ol>
</li>
@ -156,7 +163,7 @@ directories contain source code and data files:</b> </p>
tests, see <a href="api/com/ibm/test/topleveltest/TestAll.html">$Root/docs/com/ibm/test/topleveltest/TestAll.html</a>.</td>
</tr>
<tr>
<td WIDTH="20%">$Roo/src/com/ibm/tools</td>
<td WIDTH="20%">$Root/src/com/ibm/tools</td>
<td WIDTH="80%">Various tools used to generate ICU4J classes.&nbsp; <a
href="docs/cintltst.html">$Root/src/com/ibm/tools</a></td>
</tr>
@ -196,7 +203,23 @@ directories contain source code and data files:</b> </p>
</tr>
</table>
<h3><a NAME="API"></a><u>API Overview</u></h3>
<p><b>Data organization:</b> </p>
<p>Data is stored in various locations in ICU4J:
<ul>
<li>Data that is &quot;raw&quot; data goes into <strong>$Root/src/data</strong>. This
includes things like the raw Unicode database. <strong>$Root/src/data</strong> does <em>not</em>
contain <strong>.java</strong> source files.</li>
<li>Data that is in the form of a Java class, typically a ResourceBundle, but not
necessarily, goes into one of the packages <code>com.ibm.util.resources</code> or <code>com.ibm.text.resources</code>,
depending on whether the associated code lives in <code>com.ibm.util</code> or <code>com.ibm.text</code>.</li>
<li>Data that is not part of ICU4J proper (or its base tool set), but rather part of a test,
sample, or demo, should go near the source code of its owner. This makes it easy to ship a
core ICU4J release without optional components.</li>
</ul>
<h3><u>API Overview</u></h3>
<p>The complete API documentation is available on the ICU4J web site:
@ -232,7 +255,7 @@ untested and you use the components on a 1.1.x system at your own risk. </p>
<p>To install ICU4J, simply place the prebuilt jar file <strong>icu4j.jar</strong> on your
Java CLASSPATH.&nbsp; No other files are needed.</p>
<p>The prerequisites for building ICU4J are a working JDK and the Ant build system:
<p>The prerequisites for building ICU4J are a working JDK and the Ant build system:
<ul>
<li>First install a recent JDK, at least version 1.2.</li>
@ -244,8 +267,13 @@ Java CLASSPATH.&nbsp; No other files are needed.</p>
Windows 9x and Linux using Ant.</li>
<li>Installing Ant is straightforward. Download it (see <a
href="http://jakarta.apache.org/downloads/binindex.html">http://jakarta.apache.org/downloads/binindex.html</a>),
extract it onto your system, set some environment variables, and add it's bin directory to
your path. See the current Ant documentation for details.</li>
extract it onto your system, set some environment variables, and add its bin directory to
your path. For example:<pre> set JAVA_HOME=C:\jdk1.2.2
set ANT_HOME=C:\jakarta-ant
set PATH=%PATH%;%ANT_HOME%\bin
call antsetup</pre>
<p>See the current Ant documentation for details.</p>
</li>
<li>It's recommended to install both the JDK and Ant somewhere <em>outside</em> the ICU4J
directory, to keep them out of CVS's hair. For example, on Linux you might install these
in /usr/local.</li>
@ -305,20 +333,15 @@ Completed in 19 seconds</pre>
</tr>
<tr>
<td>zip</td>
<td>Create a zip archive of the source, docs, and jar file for
distribution, excluding unwanted things like CVS directories and
emacs backup files. The zip file
<strong>icu4jYYYYMMDD.zip</strong> will be created in the
directory <em>above</em> the root ICU4J directory, where YYYYMMDD
is today's date. Any existing file of that name will be
overwritten.</td>
<td>Create a zip archive of the source, docs, and jar file for distribution, excluding
unwanted things like CVS directories and emacs backup files. The zip file <strong>icu4jYYYYMMDD.zip</strong>
will be created in the directory <em>above</em> the root ICU4J directory, where YYYYMMDD
is today's date. Any existing file of that name will be overwritten.</td>
</tr>
<tr>
<td>zipsrc</td>
<td>Like the <strong>zip</strong> target, without the docs and
the jar file. The zip file <strong>icu4jsrcYYYYMMDD.zip</strong>
will be created in the directory <em>above</em> the root ICU4J
directory.</td>
<td>Like the <strong>zip</strong> target, without the docs and the jar file. The zip file <strong>icu4jsrcYYYYMMDD.zip</strong>
will be created in the directory <em>above</em> the root ICU4J directory.</td>
</tr>
<tr>
<td>clean</td>