forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r160994 - in forrest/trunk: index.html site-author/content/xdocs/docs/build.xml
Date Tue, 12 Apr 2005 00:56:34 GMT
Author: crossley
Date: Mon Apr 11 17:56:33 2005
New Revision: 160994

URL: http://svn.apache.org/viewcvs?view=rev&rev=160994
Log:
Update build instructions.

Modified:
    forrest/trunk/index.html
    forrest/trunk/site-author/content/xdocs/docs/build.xml

Modified: forrest/trunk/index.html
URL: http://svn.apache.org/viewcvs/forrest/trunk/index.html?view=diff&r1=160993&r2=160994
==============================================================================
--- forrest/trunk/index.html (original)
+++ forrest/trunk/index.html Mon Apr 11 17:56:33 2005
@@ -1,6 +1,6 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--
-  Copyright 2002-2004 The Apache Software Foundation or its licensors,
+  Copyright 2002-2005 The Apache Software Foundation or its licensors,
   as applicable.
 
   Licensed under the Apache License, Version 2.0 (the "License");
@@ -50,14 +50,14 @@
       <tt>'cd main; build.bat'</tt> (Windows)
       or <tt>'cd main; ./build.sh'</tt> (Unix).
       If you need more instructions, then see the
-      <a href="http://forrest.apache.org/build.html">Building Forrest</a>
+      <a href="http://forrest.apache.org/docs/build.html">Building Forrest</a>
       document.
    </p>
 
    <p>Forrest is ready to go! Here are some things to try ...</p>
 
     <h3>Run a webapp of the Apache Forrest documentation</h3>
-    <p>Type <tt>'forrest run'</tt> in the <code>docs-author</code>
directory.
+    <p>Type <tt>'forrest run'</tt> in the <code>site-author</code>
directory.
       You can then point your browser to 
       <a href="http://localhost:8888/">http://localhost:8888/</a>
       and view the Forrest documentation generated dynamically.
@@ -65,7 +65,8 @@
    
    <h3>Render the Forrest core documentation</h3>
    <p>Simply type <tt>'forrest'</tt> in the
-      <code>docs-author</code> directory. This will render the HTML and PDFs
for the Forrest
+      <code>site-author</code> directory. This will render all of the HTML
+      and PDFs for the Forrest
       documentation into the
       <tt>build/site/</tt> directory.
       Point your web browser to the index.html file there.
@@ -105,6 +106,6 @@
 
    <hr />
 
-   <p>Copyright 2002-2004 Apache Software Foundation. All rights reserved.</p>
+   <p>Copyright 2002-2005 Apache Software Foundation. All rights reserved.</p>
   </body>
 </html>

Modified: forrest/trunk/site-author/content/xdocs/docs/build.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/build.xml?view=diff&r1=160993&r2=160994
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/build.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/build.xml Mon Apr 11 17:56:33 2005
@@ -58,12 +58,7 @@
     </section>
 
    <section id="building">
-     <title>Building and Installing Forrest</title>
-<note>
-This document applies to the current development 0.7-dev version.
-See other instructions for the current
-<link href="http://forrest.apache.org/build.html">0.6 release</link> version.
-</note>
+     <title>Building and installing Forrest</title>
      <p>
        To build Forrest, change directory to '<code>forrest/main</code>', and
        then type '<code>build</code>' on Windows or '<code>./build.sh</code>'
on
@@ -72,7 +67,7 @@
      </p>
      <source>
   *-----------------------------------------------------------------
-  | installation notice
+  | Installation notice
   *-----------------------------------------------------------------
   | You have built the X.Y-dev version of Forrest.
   | Please set the environment variable FORREST_HOME point to
@@ -95,18 +90,23 @@
 [/svn/forrest]$ export PATH=$PATH:$FORREST_HOME/bin
      </source>
      <p>
-       After updating the Forrest source from SVN if there have been certain types of
+       After updating the Forrest source from SVN, if there have been certain types of
        updates (to the Java source for xml-forrest.jar), you will need to build forrest again.
      </p>
     </section>
 
   <section id="run">
     <title>Run Forrest, run!</title>
-    <p>Forrest is now ready to go. Type '<code>forrest run</code>' to see
-    the local webapp using the bundled Jetty server. Edit some of Forrest's
-    core documentation and see the effect.
-    The document <link href="site:your-project">Using Forrest</link> is
-    your next step.</p>
+    <p>
+      Forrest is now ready to go. To view and edit the local copy of
+      Forrest core documentation, cd to site-author and do
+      '<code>forrest run</code>' to see
+      the local webapp using the bundled Jetty server. Edit something in
+      content/xdocs/*.xml see the immediate effect.
+    </p>
+    <p>
+      The document <link href="site:your-project">Using Forrest</link> is
+      your next step.</p>
   </section>
 
 </body>



Mime
View raw message