
Refer to the general README file to learn how paths
and filenames are used in this documentation. 

Steps to undertake before MiningMart can be started
===================================================

0. You ought to read the README file.

1. You must install JAVA on your system. MiningMart is tested 
   for Java 1.4 and 1.5. For more information see
   http://java.sun.com

2. Your Oracle or Postgres installation provides a JDBC driver.
   This is a file which a Java program can use to read and write
   from the database. Your Oracle or Postgres documentation will
   tell you where to find the file. The Oracle file is often 
   called 'classes12.zip' or similar. The Postgres file is often 
   called 'postgresql.jar'.
   
   As an Oracle user, please place a copy of that file 
   into MM_HOME/lib/. If you are using Linux or Solaris, that's it.
   If you are using Windows, you may now have to edit one line in 
   the file MM_HOME\bin\mmart.bat: you will find the line 
   "set ORA=%MMART_HOME%\lib\classes12.zip" in this file.
   Change the line so that the file name is correct, ie matches
   the Oracle JDBC driver file name.
   
   If you are going to use postgres: A Postgres JDBC file is 
   already provided in MM_HOME/lib/ under the license described
   in MM_HOME/licenses/LICENSE_POSTGRESQL_JDBC. However, you
   may still have to find the JDBC file that belongs to your
   own Postgres installation if you are experiencing troubles
   (particularly for Postgres versions 8.x or higher).
   Just copy the file to MM_HOME/lib/. If you are using Linux or
   Solaris, that's it. If you are using Windows, you may now have to
   edit one line in the file MM_HOME\bin\mmart.bat: you will find
   the line "set POSTGR=%MMART_HOME%\lib\postgresql.jar" in this 
   file. Change the line so that the file name is correct, ie 
   matches the Postgres JDBC driver file name.
   
3. Open and edit the file MM_HOME/bin/mmart.sh for Linux or Solaris,
   or the file MM_HOME\bin\mmart.bat under Windows. Follow the 
   instructions given in comments in that file: there is only one
   obligatory line to edit. The line looks like this before you
   have changed it:
   
   MMART_HOME=..    or   set MMART_HOME=.\..
   
   After you have changed it, it should look something like this:
   
   MMART_HOME=/home/myname/analysis/MiningMart-1.0/
   or
   set MMART_HOME=C:\Programs\Analysis\MiningMart-1.0\
   
   Under Windows, sometimes double backslashes may be required, 
   so try this if the first version does not work:  
   set MMART_HOME=C:\\Programs\\Analysis\\MiningMart-1.0\\
           
   Save the edited version of the file under the same name.
   
4. Make sure that the file mentioned in step 3 is executable. Under
   Linux or Solaris the command "chmod u+x mmart.sh" will ensure 
   this. Under Windows, right-click on the file and change its 
   properties.
   
5. That's all. You can now run MiningMart by issuing the command
   "./mmart.sh &" from the MM_HOME/bin directory under Linux/Solaris, 
   or by double-clicking on the file MM_HOME\bin\mmart.bat under
   Windows.
   
