You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by jo...@apache.org on 2001/03/21 04:33:06 UTC

cvs commit: jakarta-velocity README.txt

jon         01/03/20 19:33:06

  Modified:    .        README.txt
  Log:
  line wrapping. added test directory
  
  Revision  Changes    Path
  1.3       +16 -13    jakarta-velocity/README.txt
  
  Index: README.txt
  ===================================================================
  RCS file: /home/cvs/jakarta-velocity/README.txt,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- README.txt	2000/12/13 01:43:52	1.2
  +++ README.txt	2001/03/21 03:33:06	1.3
  @@ -2,19 +2,20 @@
   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.
  -
  -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.
  +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.
  +
  +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.
   
   bin/        This is a temporary build directory.
   build/      This is where the build scripts live.
   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.
  +test/       This is where all of the tests live.
   
   REQUIREMENTS
   ------------
  @@ -24,8 +25,9 @@
   BUILDING VELOCITY
   -----------------
   
  -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.
  +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.
   
   Unix:
   ./build-velocity.sh
  @@ -33,13 +35,14 @@
   Win32:
   build-velocity.bat
   
  -This will create a bin/ directory containing the Velocity .jar file. Be sure to
  -update your classpath to include Velocity's .jar file.
  +This will create a bin/ directory containing the Velocity .jar file. Be
  +sure to update your classpath to include Velocity's .jar file.
   
   TRYING THE EXAMPLE
   ------------------
   
  -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.
  +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.
   
   -The Velocity Team