geirm 01/04/08 13:09:33
Modified: . README.txt
Log:
Small fixes noted by Kent Johnson
Revision Changes Path
1.5 +25 -12 jakarta-velocity/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity/README.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- README.txt 2001/03/21 03:36:51 1.4
+++ README.txt 2001/04/08 20:09:33 1.5
@@ -4,8 +4,11 @@
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.
+HTML documentation in the docs/ directory, as well as the Velocity
+web site
+ http://jakarta.apache.org/velocity/index.html
+
Here is a description of what each of the top level directories
contains. Please consult the documentation in each of the lower level
directories for information that is specific to their contents.
@@ -26,25 +29,35 @@
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 must first build it. To do
-so, cd into the build/ directory and execute the platform-specific build
-script.
+Building Velocity is easy. All components necessary to build Velocity are
+included, except for the Java 2 SDK.
+To build Velocity, change directory into the build/ directory and
+execute the platform-specific build script.
+
Unix:
-./build-velocity.sh
+./build.sh
Win32:
-build-velocity.bat
+build.bat
This will create a bin/ directory containing the Velocity .jar file. Be
-sure to update your classpath to include Velocity's .jar file.
+sure to update your classpath to include xVelocity's .jar file.
+
+TRYING THE EXAMPLES
+-------------------
-TRYING THE EXAMPLE
-------------------
+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 and Servlets. There also are examples of
+how to use Anakia, a XML transformation engine and an example of a servlet-
+based forum application.
-After building Velocity cd into the examples/ directory and run test.sh.
-This will generate a file named output which is the result of the
-test.wm input.
+For more information, please see the README.txt in the examples/ directory.
-The Velocity Team
