[csms-cvs] csms-core/src/documentation/content/downloadAndInstall index.xml,NONE,1.1

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/csms/csms-core/src/documentation/content/downloadAndInstall
In directory sc8-pr-cvs1:/tmp/cvs-serv26622

Added Files:
	index.xml 
Log Message:
Moving documentation and adding support for Forrest 0.2

--- NEW FILE: index.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"./dtd/document-v11.dtd">
<document>
  <header>
    <title>CSMS - Download and Install</title>

    <authors>
      <person id="rdg" name="Ross D. Gardler" email="ro...@sa..." />
    </authors>
  </header>

  <body>
    <section>
      <title>Downloading Released Versions</title>

      <p>To run the CSMS software you need to have installed and correctly
      configured the following software:</p>

      <ul>
        <li>
        <link href="http://www.javasfot.com/download">Java 2 Standard
        Edition</link>

        version 1.4 or higher</li>
      </ul>

      <p>You can download the latest CSMS released files from 
      <link
      href="http://sourceforge.net/project/showfiles.php?group_id=65029">
      Sourceforge</link>

      .</p>

      <section>
        <title>Installing the latest release</title>

        <p>To install the application simply unpack the archive to your chosen
        directory.</p>
      </section>

      <section>
        <title>Running the latest release</title>

        <p>To run the application cd into the bin directory which is located
        inside the directory you unzipped the archive to and run the command:
        <br />

        <code>csms</code>

        .</p>
      </section>
    </section>

    <section>
      <title>Downloading Source Code Versions</title>

      <p>To build and run the CSMS software from source code you need to have
      installed and correctly configured the following software:</p>

      <ul>
        <li>
        <link href="http://www.javasoft.com/download">Java 2 Standard
        Edition</link>

        version 1.4 or higher</li>
        
        <li>A build tool. Here you have two options:</li>
        <ul>
        <li><link href="http://www.krysalis.org/centipede">Centipede</link> gives access
        to all build tools including javadocs, cross-referenced java source code, unit
        testing, code style checks, metrics reporting and much more. This is the one you
        want if you intend to work on the source code. ( you need version 1.0beta3 or greater - note that at the time of writing 1.0beta3 has not yet been released, this means you need CVS head of Centipede)</li>
        <li><link href="http://jakarta.apache.org">ANT</link> build tool will provide minimal
        build facilities, just enough to get you going. We suport ANT because many prospective developers
        alerady have it installed and so our support of it makes it easy for you to experiment. However, for
        full development work we recomend you move to Centipede (which is built ontop of ANT
        and so you will bring all your existing knowledge with you).</li>
        </ul>
      </ul>

      <p>You can get the latest cutting edge version from 
      <link href="http://sourceforge.net/cvs/?group_id=65029">CVS</link>

      . If you are going to work with this version we strongly advise that you
      join the 
      <link href="https://sourceforge.net/mail/?group_id=65029">developers
      mailing list</link>

      to keep abreast of work on the codebase.</p>

      <p>You can also download archives of the source code for each release from
      <link
      href="http://sourceforge.net/project/showfiles.php?group_id=65029">
      Sourceforge</link></p>
      
      <section>
        <title>Building from Source</title>

        <p>We support two build systems, <link href="http://jakarta.apache.org/ant">ANT</link> and 
        <link href="http://www.krysalis.org/centipede">Centipede</link>. Ant is well known
        and used by the majority of java projects (and many others). Centipede builds on top of
        Ant. The build facilities in our Ant build file are minimal, but they provide quick
        and easy access to the major requriements of compiling and running the application. For 
        more build targets (including metrics, site generation, documentation, unit tests and
        much more you need to use Centipede).</p>
        
        <section>
          <title>Centipede</title>
        
          <p>There is an interactive build system within CSMS so to get started
          simply run the command
          <br />

          <code>cent</code><br/> from within the projects root directory
          </p>

          
          <p>For full details of the facilities available in Centipede please consult the 
          <link href="http://www.krysalis.org/centipede">Centipede</link> documentation.</p>
        </section>
        <section>
          <title>Ant</title>
          <p>A simple compile target has been provider for the convenience of ANT users. 
          Simply type the command <code>ant</code><br/> from within the projects root directory</p>
        </section>
      </section>

      <section>
        <title>Running a built system</title>

        <p>There are many ways of running the application once built from CVS,
        however, the easiest is to simply run the command
        <br />

        <code>ant run</code><br/>
        We use Ant here, as it is much faster than Centipede for such a simple task, however, you can
        also use the command <code>cent run</code> is you so desire.
        </p>
      </section>
    </section>
  </body>
</document>