From 989872e4fc52bf3ba89f44b5de04666f33703df4 Mon Sep 17 00:00:00 2001 From: David Beaumont Date: Thu, 16 Apr 2020 15:11:09 +0200 Subject: [PATCH] ICU-21078 Adding a new script and improving docs to handle installing CLDR jars. --- tools/cldr/cldr-to-icu/README.txt | 32 +++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/tools/cldr/cldr-to-icu/README.txt b/tools/cldr/cldr-to-icu/README.txt index 1b5a493a65a..18302bc60dd 100644 --- a/tools/cldr/cldr-to-icu/README.txt +++ b/tools/cldr/cldr-to-icu/README.txt @@ -16,11 +16,23 @@ Requirements Important directories --------------------- - = The top-level directory for the CLDR production data (typically - the "production" directory in the staging repository). +CLDR_ROOT = The top-level direcetory for the CLDR project, containing CLDR + code and non-production data. Usually obtained from: + https://github.com/unicode-org/cldr + +CLDR_DIR = The top-level directory for the CLDR production data (typically + the "production" directory in the staging repository). Usually + obtained from: + https://github.com/unicode-org/cldr-staging/tree/master/production + +In Posix systems, it's best to set these as exported shell variables, and any +following instructions assume they have been set accordingly: + +$ export CLDR_ROOT=/path/to/cldr +$ export CLDR_DIR=/path/to/cldr-staging/production Note that you should not attempt to use data from the CLDR project directory -(were the CLDR API code exists) for conversion into ICU data. The process now +(where the CLDR API code exists) for conversion into ICU data. The process now relies on a pre-processing step, and the CLDR data must come from the separate "staging" repository (i.e. https://github.com/unicode-org/cldr-staging) or be pre-processed locally into a different directory. @@ -30,19 +42,23 @@ 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 +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 -You also need to follow the instructions in lib/README.txt to install the CLDR -JAR files, which contain the CLDR API used by these tools. This step will only -need to be repeated if you update the code in the CLDR project you are using. +You also need to install two additional CLDR JAR files in a local Maven +repository, which can be achieved by either running: + +$ install-cldr-jars.sh "$CLDR_ROOT" + +from this directory, or following the instructions in lib/README.txt. This +step must be repeated if you update the code in the CLDR project you are +using, or are using multiple versions of the CLDR code during development. Generating all ICU data ----------------------- -$ export CLDR_DIR="" $ ant -f build-icu-data.xml -- 2.50.1