geirm 01/05/17 07:15:54
Modified: examples README.txt
Log:
Updated notes regarding how to build, and added a section on the new event handling
example
Revision Changes Path
1.11 +18 -5 jakarta-velocity/examples/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity/examples/README.txt,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- README.txt 2001/04/10 12:14:49 1.10
+++ README.txt 2001/05/17 14:15:46 1.11
@@ -11,14 +11,20 @@
To join, read http://jakarta.apache.org/site/mail.html and then follow the
link at the bottom to join the lists.
+These examples are very easy to build, but there is a prerequisite for building
+any Velocity software, a Java based build tool called 'Ant'. It can be found at
-To build these examples easily, you can just use the build script provided in the
-distribution. In the build directory (contained in the root directory of the
-distribution) :
+ http://jakarta.apache.org/ant/
-Under unix : ./build.sh examples
-Under windows : build.bat examples
+It's really a great tool. Once ant is installed and working (it's easy, don't
+worry...), you can build the example suite via :
+Change to the /build directory in the Velocity distribution and then type :
+
+ ant examples
+
+This will invoke ant and tell it to build the examples for you.
+
Velocity Examples
=================
@@ -66,6 +72,13 @@
--------------
This is simple example that demonstrates direct access of XML data via
Velocity templates, as well as Velocimacro recursion.
+
+event_example
+-------------
+This is a more advanced example, and shows how to use the event handling
+features of Velocity. This is an advanced topic, so if you are just
+starting with Velocity, you can come back to it later.
+
Thanks for using Velocity!
