------
 Getting Started
 ------

Checking Out

  Check out the sources by running the following:

+----------------------------------------
  svn checkout http://svn.apache.org/repos/asf/myfaces/tobago/trunk/ tobago
+----------------------------------------

Building

  You need {{{http://maven.apache.org/download.html}Maven 2}}(at least 2.0.3), {{{http://ant.apache.org/bindownload.cgi}Ant 1.6.5}}
  and {{{http://java.sun.com/j2se/1.5.0/download.jsp}Java 5}} to build Tobago.


  In the
  {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/}main directory}}
  you can use

+----------------------------------------
  mvn install
+----------------------------------------

  to run the install target on all sub projects. This will
  put all necessary artifacts into your local repository.

Deploying the Demo

  To deploy the demo on your local Tomcat 5.5 create a
  ~/.m2/settings.xml file based on
  {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/settings-example.xml}settings-example.xml}}.

  Make sure the manager user has the role manager; see
  $TOMCAT_HOME/conf/tomcat-users.xml.

  Change into the demo directory
  {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/demo/}example/demo}}
  and run

+----------------------------------------
  mvn tomcat:deploy
  or
  mvn tomcat:undeploy tomcat:deploy
+----------------------------------------

  Alternatively, you can run

+----------------------------------------
  mvn package
+----------------------------------------

  and deploy the WAR from the target directory
  manually.

  The demo application will create a log file in the app-server
  starting folder. You may want to change that in
  {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/demo/src/main/webapp/WEB-INF/classes/log4j.xml}src/main/webapp/WEB-INF/classes/log4j.xml}}.