You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by he...@apache.org on 2007/01/28 17:58:51 UTC
svn commit: r500833 -
/velocity/engine/branches/Velocity_1.5_BRANCH/README.txt
Author: henning
Date: Sun Jan 28 08:58:50 2007
New Revision: 500833
URL: http://svn.apache.org/viewvc?view=rev&rev=500833
Log:
Reformat README text, add a number of "Apache Velocity" phrases...
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=500833&r1=500832&r2=500833
==============================================================================
--- velocity/engine/branches/Velocity_1.5_BRANCH/README.txt (original)
+++ velocity/engine/branches/Velocity_1.5_BRANCH/README.txt Sun Jan 28 08:58:50 2007
@@ -1,11 +1,11 @@
---------
-Velocity
---------
-
-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
-web site
+---------------
+Apache Velocity
+---------------
+
+Welcome to Apache Velocity! Apache 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 web site.
http://velocity.apache.org/index.html
@@ -16,7 +16,7 @@
bin/ This is a temporary build directory.
build/ This is where the build scripts live.
contrib/ The home for source code which is not officially maintained.
-convert/ The WebMacro to Velocity conversion program.
+convert/ The WebMacro to Apache Velocity conversion program.
docs/ This is where the documentation lives.
examples/ This is where the examples live.
src/ This is where all of the source code to Velocity lives.
@@ -29,50 +29,54 @@
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 or
-greater.
+Apache Velocity will run with any version of Java greater than 1.3.
+
+Building from source 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.
+If you are using an offical Apache Velocity release distribution, you
+will find two pre-built 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.
+ This jar does not include any external dependencies needed by
+ Velocity, such as the commons-collection classes, the Avalon
+ Logkit, or Apache 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.
+ This jar includes all dependencies that were present in 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.
Please see the WHY_TWO_JARS.txt file for more information.
-BUILDING VELOCITY
------------------
+BUILDING APACHE VELOCITY
+------------------------
-In order to use the latest version of Velocity, you may want to build
-it.
+In order to use the latest version of Apache Velocity, you may want to
+build it.
-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:
+Building is easy. All components necessary to build are included or
+get downloaded from the internet during the build, except for the Java
+2 SDK and the Ant build tool. You can find details on how to build
+Velocity online at:
http://velocity.apache.org/engine/devel/build.html
Note that you must use Ant version 1.6 or later.
+*IMPORTANT* As the Apache Velocity build process wants to download a
+ number of jars from the internet, you must be online when you are
+ building for the first time.
+
To build Velocity's jar, change directory into the build/ directory
and enter:
@@ -83,8 +87,8 @@
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 jar that contains all dependencies, we have
+provided an optional build target for your convenience:
ant jar-dep
@@ -105,4 +109,4 @@
For more information, please see the README.txt in the examples/
directory.
--The Velocity Team
+- The Apache Velocity Team