]> granicus.if.org Git - icu/commitdiff
ICU-20693 Remember to mention the JAR setup
authorDavid Beaumont <david.beaumont+github@gmail.com>
Fri, 22 Nov 2019 02:10:34 +0000 (02:10 +0000)
committerSteven R. Loomis <srl295@gmail.com>
Wed, 18 Dec 2019 18:45:43 +0000 (10:45 -0800)
See #900

tools/cldr/cldr-to-icu/README.txt

index e850345d9a0ab662fd038c75cff1dab62d08cf1f..e921914fece0cc7ca8778eba81332054dba43797 100644 (file)
@@ -6,14 +6,35 @@
 Basic instructions for running the LdmlConverter via Maven
 ==========================================================
 
+Requirements
+------------
+
+* A CLDR release for supplying CLDR data and the CLDR API.
+* The Maven build tool
+* The Ant build tool
+
 Important directories
 ---------------------
 
-<CLDR_DIR>  = The root directory of the CLDR release.
+<CLDR_DIR>  = The top-level directory for the CLDR production data (typically
+              the "production" directory in the staging repository).
 
 <OUT_DIR>   = The output directory into which ICU data files should be written.
 
 
+Initial Setup
+-------------
+
+This project relies on the Maven build tool for managing dependencies and uses
+Ant for configuration purposes, so both will need to be installed. On a debian
+based system, this should be as simple as:
+
+$ sudo apt-get install maven ant
+
+See also lib/README.txt for instructions on how to install the CLDR JAR files
+which contains the CLDR API used by these tools. This step will only need to
+be repeated when you update the CLDR project you are using.
+
 Generating all ICU data
 -----------------------
 
@@ -25,9 +46,7 @@ $ CLDR_DIR=<CLDR_DIR> ant -f build-icu-data.xml
 Running unit tests
 ------------------
 
-$ mvn test \
-  -DCLDR_DIR='<CLDR_DIR>' \
-  -DCLDR_DTD_CACHE='<DTD_CACHE>'
+$ mvn test -DCLDR_DIR=<CLDR_DIR>
 
 
 Importing and running from an IDE
@@ -36,4 +55,4 @@ Importing and running from an IDE
 This project should be easy to import into an IDE which supports Maven development, such
 as IntelliJ or Eclipse. It uses a local Maven repository directory for the unpublished
 CLDR libraries (which are included in the project), but otherwise gets all dependencies
-via Maven's public repositories.
\ No newline at end of file
+via Maven's public repositories.