svn commit: r500774 - /velocity/engine/branches/Velocity_1.5_BRANCH/README.txt

[he...@apache.org]

Author: henning
Date: Sun Jan 28 02:28:50 2007
New Revision: 500774

URL: http://svn.apache.org/viewvc?view=rev&rev=500774
Log:
Update and reformat README information.


Modified:
    velocity/engine/branches/Velocity_1.5_BRANCH/README.txt

Modified: velocity/engine/branches/Velocity_1.5_BRANCH/README.txt
URL: http://svn.apache.org/viewvc/velocity/engine/branches/Velocity_1.5_BRANCH/README.txt?view=diff&rev=500774&r1=500773&r2=500774
==============================================================================
--- velocity/engine/branches/Velocity_1.5_BRANCH/README.txt (original)
+++ velocity/engine/branches/Velocity_1.5_BRANCH/README.txt Sun Jan 28 02:28:50 2007
@@ -3,8 +3,8 @@
 --------
 
 Welcome to Velocity. Velocity is a general purpose template engine
-written in Java. For more information about Velocity, please look at the
-HTML documentation in the docs/ directory, as well as the Velocity
+written in Java. For more information about Velocity, please look at
+the HTML documentation in the docs/ directory, as well as the Velocity
 web site
 
   http://velocity.apache.org/index.html
@@ -24,80 +24,85 @@
 whiteboard/ The place for developer experimentation (unmaintained).
 xdocs/      This is the .xml files for building the .html files
             related to the website and documentation.
+
             
 REQUIREMENTS
 ------------
 
-Velocity will run with any version of Java greater than 1.3.
-Building Velocity requires Java version 1.4 (or greater) and 
-ant 1.6.
+Velocity will run with any version of Java greater than 1.3.  Building
+Velocity requires Java version 1.4 (or greater) and ant 1.6 or
+greater.
 
 
 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.
+If you are using an offical Velocity release distribution, you will
+find two pre-built Velocity jars in the top level directory.
+
+1) velocity-<version>.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-<version>.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 distribution in place of
+    existing 1.1 or 1.2-dep distributions.
 
-1) velocity-<version>.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-<version>.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.3 distribution in place of existing 1.1 or 1.2-dep
- distributions.
+Please see the WHY_TWO_JARS.txt file for more information.
 
-Please see the developers guide for more information.
 
 BUILDING VELOCITY
 -----------------
 
-In order to use the latest version of Velocity, you may want to build it. 
+In order to use the latest version of 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.
-You can find details on how to build Velocity online at:
+Building Velocity is easy.  All components necessary to build Velocity
+are included or get downloaded from the internet during the build,
+except for the Java 2 SDK and the fabulous Ant build tool.  You can
+find details on how to build Velocity online at:
 
-http://velocity.apache.org/engine/devel/build.htm
+http://velocity.apache.org/engine/devel/build.html
 
 Note that you must use Ant version 1.6 or later.
 
-To build Velocity's jar, change directory into the build/ directory and 
-simply type :
+To build Velocity's jar, change directory into the build/ directory
+and enter:
 
 ant jar
 
-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.
+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 :
+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
+This will build a complete Velocity jar with dependencies included,
+and it can be found in the /bin directory as
 
 velocity-dep-<version>.jar
 
+
 TRYING THE EXAMPLES
 -------------------
 
-After building Velocity, you can also buld the examples that are included
-with the Velocity distribution.  These examples show how to use Velocity
-in your Java applications.  There also are examples of
+After building Velocity, you can also buld the examples that are
+included with the Velocity distribution.  These examples show how to
+use Velocity in your Java applications.  There also are examples of
 how to use Anakia, a XML transformation engine.
 
-For more information, please see the README.txt in the examples/ directory.
+For more information, please see the README.txt in the examples/
+directory.
 
 -The Velocity Team