MaVerick Installation Instructions

Here are (hopefully) some simple install instructions to get MaVerick going. There are 2 kinds of install:


Basic Install

  1. Get requisites:

    At a minimum requires Java Runtime version 1.3 with 1.4 or above recommended(http://java.sun.com/)

    Many operating systems already have a java runtime installed at the DOS or unix shell prompt try typing:

            java -version   (should work for java 1.2+) 
        

    If any of the above commands are successful, you already have a java vm installed. For a basic install you only need a java runtime, not a full development kit. If your machine does not have a VM download one from one of the links below:

    If you do not a java vm installed and are not using one of the systems above try:

    or get in touch with your operating system vendor.

  2. Unzip distribution files

    The distribution is in tar-gzip form use the tar and gzip utilities on unix, perhaps winzip or similar or windows to extract the archive to a suitable location.

  3. Create maverick.properties

    You need to create a maverick.properties file in the etc directory. This file contains all the configuration settings used by the runtime. To start with there is a sample file sample.maverick.properties in the etc directory which may be copied across.

           ie   cd etc
                copy sample.maverick.properties maverick.properties
                edit maverick.properties
        
  4. Modify PATH

    Add the maverick/bin directory to your path.

    Also under Windows 95/98/ME you also need to set the MAVERICK_HOME environment variable to the location where you installed the distribution(This is not necessary for Windows NT/2000/XP).

  5. Write small test program
        ie TEST.BAS:
            PRINT "Hello World!"
        to compile
            BASIC TEST.BAS
        to run
            RUN TEST
        

    If it prints "Hello World!" then you have successfully completed the install.


Developer Install

If you wish to work on up to date versions and help with coding of maverick you will need to do a developer install.

  1. Get requisites:

    Ensure you have these tools available:

    • Java Developer Kit 1.3 or better(see section 1 of the user install). To compile the software you need a full developers kit, or possibly a java runtime and standalone java compiler like jikes.
    • Antlr parser generator(http://www.antlr.org/)
    • Ant build tool(http://jakarta.apache.org/ant/) or GNU gmake
    • Junit Test Suite(http://www.junit.org/) if you wish to run the test suite.
  2. Get distribution files

    Available either by file download(release version or snapshot) or via Subversion.

    Note that Subversion is the hardest to setup but is then easiest to keep synchronized with other developers

  3. Setup local definitions

    Copy the etc/sample.maverick.properties to etc/maverick.properties and edit to suit local settings.

    If using the ant build tool copy the etc/sample.build.properties file to the base directory of the distribution and rename to 'build.properties' and then modify to suit local conventions. If using gmake then edit etc/Makefile.defs. For both build tools you will at least need to specify the install location of the antlr tool.

  4. Build from source

    In the base directory run ant which should build the binaries.

    To run the test suite copy junit.jar into the maverick/lib directory. Then if using ant then copy etc/sample.test.properties into the base directory as 'test.properties' edit if necessary and run 'ant test' to run the test suite

  5. Write a small test program
        ie TEST.BAS:
            PRINT "Hello World!"
        to compile
            BASIC TEST.BAS
        to run
            RUN TEST
    

    If it prints "Hello World!" then you have successfully completed the install and build.