[apple/icu.git] / icuSources / test / letest / readme.html

<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
  <meta http-equiv="Content-Type"
 content="text/html; charset=iso-8859-1">
  <meta name="Copyright"
 content="Copyright (c) 2001-2005, International Business Machines Corporation and others. All Rights Reserved.">
  <meta name="Author" content="Eric Mader">
  <meta name="GENERATOR"
 content="Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
  <title>Readme file for letest and gendata</title>
</head>
<body>
<h2> What are letest and gendata?</h2>
letest is a program you can use to verify that you have built and
installed the ICU LayoutEngine correctly. The test is not
comprehensive,
it just verifies that the results of laying out some Devanagari, Arabic
and Thai text are as expected. Once this test has passed, you can use
the ICU LayoutEngine in your application knowing that it has been
correctly installed and that the basic functionality is in place.
<p>gendata is a program that is used by the ICU team to build the
source file testdata.cpp, which contains the expected results of
running
letest. Unless you have changed your copy of the LayoutEngine and want
to validate the changes on other platforms, there's no reason for you
to run this program. </p>
<p>(The ICU team first runs a Windows application which uses the ICU
LayoutEngine to display the text that letest uses. Once it has been
verified that the text is displayed correctly, gendata is run to
produce
testdata.cpp, and then letest is run on Windows to verify that letest
still works with the new data.) <br>
&nbsp; </p>
<h2> How do I build letest?</h2>
First, you need to build ICU, including the LayoutEngine.
<p>On Windows, the layout project should be listed as a dependency of
all, so layout will build when you build all. If it doesn't for some
reason, just select the layout project in the project toolbar and build
it. </p>
<p>On UNIX systems, you need to add the "--enable-layout=yes" option
when you invoke the runConfigureICU script. When you've done that,
layout should build when you do "make all install" </p>
<p>To build letest on Windows, just open the letest project in
&lt;icu&gt;\source\test\letest and build it. On UNIX systems, connect
to
&lt;top-build-dir&gt;/test/letest and do "make all" <br>
&nbsp; </p>
<h2> How do I run letest?</h2>
Before you can run letest, you'll need to get the fonts it uses. For
legal reasons, we can't include them with ICU, but you can download
them
from the web. To do this, you'll need access to a computer running
Windows. Here's how to get the fonts:
<p>Download a recent version of the Java 2 Platform, Standard Edition
(J2SE) from <a href="http://java.sun.com/j2se.index.jsp">java.sun.com</a>.
From this page, follow the link for the version you want to download,
and then select the "Downloads" link on the left side of the page.
Select either the SDK or the JRE. (The JRE is sufficient for letest.)
Read the license agreement and click on "Accept" if you agree. This
will take you to the actual download page. Download the package and
install it. You'll need one font. On Windows, it will be in, for
example, "C:\j2sdk1.4.2_06/jre/lib/fonts. The file you want is
"LucidaSansRegular.ttf". Copy this file into the directory from which
you'll run letest.<br>
</p>
<p>Next is the Hindi font. Go to the&nbsp; NCST site and download&nbsp;<a
 href="http://rohini.ncst.ernet.in/indix/download/font/raghu.ttf">
raghu.ttf</a>. Be sure to look at the <a
 href="http://rohini.ncst.ernet.in/indix/download/font/README">README</a>
file before you download the font. You can download raghu.ttf into the
directory from which you'll run letest.<br>
</p>
<p>Then download the Thai font. Go to <a
 href="http://www.into-asia.com/thai_language/thaifont/">into-asia.com</a>
and click on the link for the Angsana font. This will download a .ZIP
file. Extract the font file, angsd___.ttf, into the directory from
which you will run letest.<br>
</p>
<p>There's still one more font to get, the Code2000 Unicode font.Go to
James Kass' &nbsp;<a href="http://home.att.net/%7Ejameskass/">Unicode
Support In Your Browser</a> page and click on the link that says "Click
Here to download Code2000 shareware demo Unicode font." This will
download a .ZIP file which contains CODE2000.TTF and CODE2000.HTM.
Expand this .ZIP file and put the CODE2000.TTF file in the directory
from which you'll run letest.<br>
</p>
<p><span style="font-weight: bold;">Note:</span> The Code2000 font is
shareware. If you want to use it for longer than a trial period, you
should send a shareware fee to James. Directions for how to do this are
in CODE2000.HTM.</p>
<p>That's it! Now all you have to do is run letest (CTRL+F5 in Visual
C++, or "./letest" in UNIX) If&nbsp; everything's OK you should see
something like this: </p>
<blockquote><tt>Test 0, font = raghu.ttf... passed.</tt> <br>
  <tt>Test 1, font = CODE2000.TTF... passed.</tt> <br>
  <tt>Test 2, font = LucidaSansRegular.ttf... passed.</tt> <br>
  <tt>Test 3, font = angsd___.ttf... passed.</tt></blockquote>
</body>
</html>
Commit	Line	Data
b75a7d8f A	1	<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
	2	<html>
	3	<head>
	4	<meta http-equiv="Content-Type"
	5	content="text/html; charset=iso-8859-1">
	6	<meta name="Copyright"
73c04bcf	7	content="Copyright (c) 2001-2005, International Business Machines Corporation and others. All Rights Reserved.">
b75a7d8f A	8	<meta name="Author" content="Eric Mader">
	9	<meta name="GENERATOR"
	10	content="Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
	11	<title>Readme file for letest and gendata</title>
	12	</head>
	13	<body>
	14	<h2> What are letest and gendata?</h2>
	15	letest is a program you can use to verify that you have built and
73c04bcf A	16	installed the ICU LayoutEngine correctly. The test is not
73c04bcf A	17	comprehensive,
b75a7d8f A	18	it just verifies that the results of laying out some Devanagari, Arabic
	19	and Thai text are as expected. Once this test has passed, you can use
	20	the ICU LayoutEngine in your application knowing that it has been
	21	correctly installed and that the basic functionality is in place.
	22	<p>gendata is a program that is used by the ICU team to build the
73c04bcf A	23	source file testdata.cpp, which contains the expected results of
73c04bcf A	24	running
b75a7d8f A	25	letest. Unless you have changed your copy of the LayoutEngine and want
	26	to validate the changes on other platforms, there's no reason for you
	27	to run this program. </p>
	28	<p>(The ICU team first runs a Windows application which uses the ICU
	29	LayoutEngine to display the text that letest uses. Once it has been
73c04bcf A	30	verified that the text is displayed correctly, gendata is run to
73c04bcf A	31	produce
b75a7d8f A	32	testdata.cpp, and then letest is run on Windows to verify that letest
	33	still works with the new data.) <br>
	34	</p>
	35	<h2> How do I build letest?</h2>
	36	First, you need to build ICU, including the LayoutEngine.
	37	<p>On Windows, the layout project should be listed as a dependency of
	38	all, so layout will build when you build all. If it doesn't for some
	39	reason, just select the layout project in the project toolbar and build
	40	it. </p>
	41	<p>On UNIX systems, you need to add the "--enable-layout=yes" option
	42	when you invoke the runConfigureICU script. When you've done that,
	43	layout should build when you do "make all install" </p>
	44	<p>To build letest on Windows, just open the letest project in
73c04bcf A	45	<icu>\source\test\letest and build it. On UNIX systems, connect
73c04bcf A	46	to
b75a7d8f A	47	<top-build-dir>/test/letest and do "make all" <br>
	48	</p>
	49	<h2> How do I run letest?</h2>
	50	Before you can run letest, you'll need to get the fonts it uses. For
73c04bcf A	51	legal reasons, we can't include them with ICU, but you can download
73c04bcf A	52	them
b75a7d8f A	53	from the web. To do this, you'll need access to a computer running
b75a7d8f A	54	Windows. Here's how to get the fonts:
73c04bcf A	55	<p>Download a recent version of the Java 2 Platform, Standard Edition
	56	(J2SE) from <a href="http://java.sun.com/j2se.index.jsp">java.sun.com</a>.
	57	From this page, follow the link for the version you want to download,
	58	and then select the "Downloads" link on the left side of the page.
	59	Select either the SDK or the JRE. (The JRE is sufficient for letest.)
	60	Read the license agreement and click on "Accept" if you agree. This
	61	will take you to the actual download page. Download the package and
	62	install it. You'll need one font. On Windows, it will be in, for
	63	example, "C:\j2sdk1.4.2_06/jre/lib/fonts. The file you want is
	64	"LucidaSansRegular.ttf". Copy this file into the directory from which
	65	you'll run letest.<br>
b75a7d8f A	66	</p>
	67	<p>Next is the Hindi font. Go to the  NCST site and download <a
	68	href="http://rohini.ncst.ernet.in/indix/download/font/raghu.ttf">
73c04bcf A	69	raghu.ttf</a>. Be sure to look at the <a
73c04bcf A	70	href="http://rohini.ncst.ernet.in/indix/download/font/README">README</a>
b75a7d8f A	71	file before you download the font. You can download raghu.ttf into the
	72	directory from which you'll run letest.<br>
	73	</p>
73c04bcf A	74	<p>Then download the Thai font. Go to <a
	75	href="http://www.into-asia.com/thai_language/thaifont/">into-asia.com</a>
	76	and click on the link for the Angsana font. This will download a .ZIP
	77	file. Extract the font file, angsd___.ttf, into the directory from
	78	which you will run letest.<br>
	79	</p>
b75a7d8f A	80	<p>There's still one more font to get, the Code2000 Unicode font.Go to
	81	James Kass'  <a href="http://home.att.net/%7Ejameskass/">Unicode
	82	Support In Your Browser</a> page and click on the link that says "Click
	83	Here to download Code2000 shareware demo Unicode font." This will
	84	download a .ZIP file which contains CODE2000.TTF and CODE2000.HTM.
	85	Expand this .ZIP file and put the CODE2000.TTF file in the directory
	86	from which you'll run letest.<br>
	87	</p>
	88	<p><span style="font-weight: bold;">Note:</span> The Code2000 font is
	89	shareware. If you want to use it for longer than a trial period, you
	90	should send a shareware fee to James. Directions for how to do this are
	91	in CODE2000.HTM.</p>
	92	<p>That's it! Now all you have to do is run letest (CTRL+F5 in Visual
	93	C++, or "./letest" in UNIX) If  everything's OK you should see
	94	something like this: </p>
	95	<blockquote><tt>Test 0, font = raghu.ttf... passed.</tt> <br>
	96	<tt>Test 1, font = CODE2000.TTF... passed.</tt> <br>
	97	<tt>Test 2, font = LucidaSansRegular.ttf... passed.</tt> <br>
73c04bcf	98	<tt>Test 3, font = angsd___.ttf... passed.</tt></blockquote>
b75a7d8f A	99	</body>
b75a7d8f A	100	</html>