1$Id: COMPILE,v 1.5 2003/12/29 03:58:33 dfs Exp $
2
3The Jakarta-ORO library follows the same build procedure as other
4Jakarta projects, relying on the Ant build system.  You can learn more
5about the Ant build system from http://jakarta.apache.org/.  If
6you don't have Ant installed on your system, you must download and
7install it to compile the software.
8
9By default, build.xml will build a jar file containing the library.
10Optionally, you can pass one of the following build targets as an
11argument to Ant:
12	 lib	      - builds the library
13	 examples     - builds the example programs
14	 examples-awk - builds the org.apache.oro.text.awk examples
15	 tools        - builds the utility programs
16	 jar          - builds a jar file containing the class library
17	 javadocs     - builds the API documentation
18	 package      - builds a source distribution package
19	 package-zip  - builds a distribution package stored as a zip file
20	 package-tgz  - builds a distribution package stored as a
21			gzipped tar file (.tar.gz)
22	 clean        - removes all files generated by build targets
23
24All generated class files are stored in a classes/ directory.  All
25documentation is stored in a doc/ directory.
26
27Examples:
28	To build only the library use:
29
30	   ant lib
31
32	To build only the javadocs use:
33
34	   ant javadocs
35
36NOTE FOR DEVELOPERS
37-------------------
38
39As of 2003/12/28, all generated documentation under the docs/ tree is
40stored in CVS.  This is done so that the infrastructure team can
41regenerate project pages without having to build individual software
42distributions.  Therefore, after you make changes in xdocs or update
43the demo applet, you must do a checkin of any updated or new artifacts
44in the docs/ tree.  First do an 'ant docs' and then do the requisite
45checkins.  Do not directly edit any of the files under the docs/
46tree.  They are to be generated from the source under xdocs.
47
48