Tree [8c2364] default tip /
History



File Date Author Commit
vars-annotation 2012-09-15 Brian Schlining Brian Schlining [8c2364] check point
vars-core 2012-08-04 Brian Schlining Brian Schlining [d5e5d7] Adding new Painters
vars-jpa 2012-09-01 Brian Schlining Brian Schlining [cf18e2] Fixed issues with measurement tools in the Imag...
vars-knowledgebase 2012-06-26 Brian Schlining Brian Schlining [cba799] rev'd version to 6.1.3-SNAPSHOT
vars-query 2012-06-26 Brian Schlining Brian Schlining [cba799] rev'd version to 6.1.3-SNAPSHOT
vars-quicktime 2012-06-26 Brian Schlining Brian Schlining [cba799] rev'd version to 6.1.3-SNAPSHOT
vars-shared-ui 2012-07-13 Brian Schlining Brian Schlining [01734f] check point
vars-standalone 2012-09-15 Brian Schlining Brian Schlining [8c2364] check point
.hgignore 2012-01-05 Brian Schlining Brian Schlining [77a447] Migrating VARSPUB to new server
.hgtags 2012-06-26 Brian Schlining Brian Schlining [831c5a] Added tag VARS-6.1.2-vcr for changeset f863c9ca...
README.txt 2012-04-06 Brian Schlining Brian Schlining [47daf5] mb:aead7197-cb83-450a-844b-59d437a214f6.
pom.xml 2012-07-13 Brian Schlining Brian Schlining [01734f] check point

Read Me

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to build VARS you will need to have the following installed:
	1) Java 6 (https://jdk6.dev.java.net/)
	2) Maven 2 or 3 (http://maven.apache.org)
	
VARS also requires that QuickTime for Java to be installed in order to run
the annotation application. However, you do not need QuickTime to compile VARS.
QuickTime for Java is included by default on Mac OS X. On Windows, you will need
to install it. You can download if from http://developer.apple.com/quicktime/. 
Alternatively, it is installed when you install iTunes.
	
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
FETCHING THE SOURCE CODE
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The VARS source code is stored in a Mercurial repository. Instructions for 
obtaining the VARS source code can be found at 
http://code.google.com/p/vars-redux/source/checkout. 
For those familiar with hg, the checkout command is:
    
    hg clone https://vars-redux.googlecode.com/hg/ vars-redux
    
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
YOUR FIRST BUILD
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
VARS is co-developed alongside several other external modules. Normally these
modules are retrieved from the maven repository at 
http://mbari-maven-repository.googlecode.com/svn/repository/
and you do not need to think about them since Maven takes care of fetching them
for you. However, between VARS releases features may be added to these modules
that can not be found in the versions stored in the Maven repository. If you
attempt to build VARS and get errors. You may need to fetch the source code for 
the modules and build and install them into your local repository. The related
modules can be found at:

    # MBARIX4J at http://code.google.com/p/mbarix4j/
    # Execute the following commands to build and install in your local maven repository
    svn checkout http://mbarix4j.googlecode.com/svn/trunk/ mbarix4j
    cd mbarix4j
    mvn install
    
    # VCR4J at http://code.google.com/p/vcr4j/
    # Execute the following commands to build and install in your local maven repository
    svn checkout http://vcr4j.googlecode.com/svn/trunk/ vcr4j
    cd vcr4j
    mvn install

    # QTX4J at http://code.google.com/p/qtx4j/
    # Execute the following commands to build and install in your local maven repository
    svn checkout http://qtx4j.googlecode.com/svn/trunk/ qtx4j
    cd qtx4j
    mvn install
    
Normally Maven expects you to have an internet connection when running builds. However,
if you want to checkout the VARS code and build it offline you can do that as follows:

    # Fetch all the dependencies while you're online
    mvn dependency:go-offline
    
    #Build VARS later offline 
    mvn install -P dev -o
    
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
BUILDING VARS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	
To Build VARS, run the following command on the command line:
	mvn clean install -P dev

A standalone application will be built to  
vars-redux/vars-standalone/target/vars-standalone-[VERSION]-scripting.zip.

The 'environment' variable specifies what database you are targeting, for most
folks that will be 'dev'. i