geirm 01/12/10 04:00:04 Modified: . README.txt Log: update to HEAD from the 1.2 branch Revision Changes Path 1.10 +42 -7 jakarta-velocity/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/jakarta-velocity/README.txt,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- README.txt 2001/11/12 17:08:10 1.9 +++ README.txt 2001/12/10 12:00:04 1.10 @@ -25,17 +25,40 @@ REQUIREMENTS ------------ -The Java 2 SDK is required to build and run Velocity. +The Java 2 SDK is required to build Velocity. -For users that wish to use Log4J as the logging system, version 1.1 of -Log4J is required. +For users that wish to use Log4J as the logging +system, version 1.1 or newer of Log4J is required. + +INCLUDED PRE-BUILT JARS +----------------------- +If you are using an offical Velocity release distribution, +you will find two pre-built Velocity jars in the top level +directory. + +PLEASE NOTE : Starting with the 1.2 release, we include two jars + with the distribution. + +1) velocity-1.2.jar : The Velocity jar that does not include +any external dependencies needed by Velocity, such as the +jakarta-commons-collection classes, Jakarta Avalon Logkit, or +Jakarta ORO. We do this to allow you to use whatever version of +collections, logkit, etc that you wish w/o fear of collision. +These jars are included in the distribution, in +the build/lib directory, or at the respective project sites. + +2) velocity-dep-1.2.jar : This is a Velocity jar that includes +all dependencies that were included with previous distribution +jars. It is intended as a convenience to allow you to drop +this 1.2 distribution in place of existing 1.1 distributions. + +Please see the developers guide for more information. + BUILDING VELOCITY ----------------- -In order to get started with Velocity, you may want to build it. If -you are working with an offical Velocity release package, you will find -the Velocity jar in the top level directory. +In order to get started with Velocity, you may want to build it. Building Velocity is easy. All components necessary to build Velocity are included, except for the Java 2 SDK and the fabulous Ant build tool @@ -43,14 +66,26 @@ http://jakarta.apache.org/ant/ +Note that you must use Ant version 1.4 or later. + To build Velocity's jar, change directory into the build/ directory and simply type : ant jar -This will create a bin/ directory containing the Velocity .jar file. Be +This will create a bin/ directory containing the Velocity .jar file. Be sure to update your classpath to include Velocity's .jar file, or when using a modern servlet container, put it in the WEB-INF/lib directory. + +If you wish to build a Velocity jar that contains all dependencies, we have +provided an optional build target for our convenience : + +ant jar-dep + +This will build a complete Velocity jar with dependencies included, and it can +be found in the /bin directory as + +velocity-dep-1.2.jar TRYING THE EXAMPLES -------------------
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
