[CIShell-SVN] SF.net SVN: cishell: [775] trunk/core/org.cishell.docs

[<bh...@us...>]

Revision: 775
          http://cishell.svn.sourceforge.net/cishell/?rev=775&view=rev
Author:   bh2
Date:     2008-04-23 11:08:19 -0700 (Wed, 23 Apr 2008)

Log Message:
-----------
Added some documentation and made the ant script no longer automatically build the dev_guide when called w/ no args since the dev guide is being done on the wiki now.

Modified Paths:
--------------
    trunk/core/org.cishell.docs/build.xml

Added Paths:
-----------
    trunk/core/org.cishell.docs/README

Added: trunk/core/org.cishell.docs/README
===================================================================
--- trunk/core/org.cishell.docs/README	                        (rev 0)
+++ trunk/core/org.cishell.docs/README	2008-04-23 18:08:19 UTC (rev 775)
@@ -0,0 +1,23 @@
+CIShell Specification Project
+-----------------------------
+CIShell 1.0 specification and build system by Bruce Herr. The Javadoc->Latex 
+doclet (TexDoclet) originally from https://texdoclet.dev.java.net/ was 
+customized by Bruce Herr.
+
+The build system was originally set up so that we could create the specification,
+developer guide, and other CIShell related documents. We are now doing the 
+developer guide at the CIShell Wiki ( https://cishell.org/?n=DevGuide.HomePage ).
+The initial workings of the dev_guide using LaTeX is left here as an example of 
+how another document could be integrated. 
+
+USING THE BUILD SYSTEM:
+Using ant, you will typically just run 'ant' and it'll build the spec. 
+'ant clean' can be used to clean up the generated files. You can look at the 
+build.xml file for other possible commands.
+
+In order to inject the API docs into the specification, you must have the 
+org.cishell.framework bundle checked out in the same directory as this project.
+If you are in eclipse, then just check it out into your workspace. 'ant 
+javadoc-tex' will invoke the javadoc command using the customized texdoclet 
+which will create an api.tex file in src/specification/tex/.
+

Modified: trunk/core/org.cishell.docs/build.xml
===================================================================
--- trunk/core/org.cishell.docs/build.xml	2008-04-07 19:53:22 UTC (rev 774)
+++ trunk/core/org.cishell.docs/build.xml	2008-04-23 18:08:19 UTC (rev 775)
@@ -2,7 +2,7 @@
 <project name="CIShell Documentation" default="all">
 	<property file="build.properties" />
 	
-	<target name="all" depends="javadoc-tex,build-spec,build-guide,setup"/>
+	<target name="all" depends="javadoc-tex,build-spec,setup"/>
 	
 	<target name="setup">
 		<mkdir dir="${build.dir}"/>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.