You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by jv...@locus.apache.org on 2000/10/05 04:07:28 UTC

cvs commit: jakarta-velocity/xdocs contributors.xml getting-started.xml

jvanzyl     00/10/04 19:07:25

  Modified:    xdocs    contributors.xml getting-started.xml
  Log:
  edits
  
  Revision  Changes    Path
  1.4       +1 -1      jakarta-velocity/xdocs/contributors.xml
  
  Index: contributors.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-velocity/xdocs/contributors.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- contributors.xml	2000/10/03 01:10:17	1.3
  +++ contributors.xml	2000/10/05 02:07:23	1.4
  @@ -22,7 +22,7 @@
   
   <p>
       If you would like to contribute to Velocity, please see the 
  -    <a href="todo.html">to do</a> list to find areas where you can contribute. 
  +    <link href="todo.html">to do</link> list to find areas where you can contribute. 
       If there is nothing in there that suits your interest, but you still have 
       ideas, please feel free to suggest them on the mailing list.
   </p>
  
  
  
  1.3       +23 -6     jakarta-velocity/xdocs/getting-started.xml
  
  Index: getting-started.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-velocity/xdocs/getting-started.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- getting-started.xml	2000/09/30 20:11:47	1.2
  +++ getting-started.xml	2000/10/05 02:07:24	1.3
  @@ -17,19 +17,36 @@
   <p>
       This document provides developers with simple documentation for getting
       started with Velocity. For information about the overall structure of
  -    Velocity, please refer to the <a href="design.html">Design Document</a>.
  +    Velocity, please refer to the <link href="design.html">Design</link> document.
   </p>
   
   <p>
       Instructions for downloading and installing Velocity can be found on the
  -    <a href="install.html">INSTALL</a> document.
  +    <link href="install.html">Install</link> document.
   </p>    
   
  +<s1 title="View Detailed API Documentation">
  +
   <p>    
  -    If you would like to view the detailed API documentation, run 
  -    "build-velocity.sh|bat javadocs" from the "build" directory. 
  -    This will create a full set of Velocity API docs in 
  -    the "docs/apidocs" directory. 
  +    If you are working on Unix/Linux and would like to create a full set 
  +    of detailed API documentation for Velocity, go to the "build" directory
  +    and run the following script.
  +    
  +    <source><![CDATA[
  +    
  +    ./build-velocity.sh
  +    
  +    ]]></source>
  +    
  +    If you are working on Windows, the following command will have the same 
  +    effect.
  +    
  +    <source><![CDATA[
  +    
  +    build-velocity.bat
  +    
  +    ]]></source>
  +     
   </p>
   
   </s1>