This is the README file of the MiningMart distribution.
-------------------------------------------------------

You have successfully unpacked MiningMart. You need to
do a few things before you can run it, but it should be 
very simple. This document provides an overview of what 
to do; it refers to some other files in this distribution
which explain some steps in more detail.

You can find the MiningMart user guide in the 
MM_HOME/doc directory, or you can download it directly 
from the MiningMart website.

Contents:
---------
0. File names and paths 
1. Preparing the database
2. Preparing and starting the software
3. Support


Chapter 0: File names and paths
-------------------------------

Unpacking the file you have downloaded has created a 
directory MiningMart-1.1. Throughout this and other files
the path up to and including this directory is called MM_HOME. 
When you see other file names, replace MM_HOME with the complete
path to the MiningMart-1.1 directory to find it. For example,
if you see the file name

MM_HOME/lib/mmart.jar

in a description, this means that you find the file mmart.jar 
in the directory

C:\Programs\MiningMart-1.1\lib\

to use a Windows example, or in

/home/myname/analysis/MiningMart-1.1/lib/

under Linux or Solaris, for example.


Chapter 1: Preparing the database
---------------------------------

MiningMart needs a relational database system. The current
version (1.1) supports Oracle and Postgres. The system was 
tested on Oracle 8.1.6 and Postgres 7.2 and 7.3, but it should
also run on versions with higher numbers.

MiningMart can use two different database schemas at the same
time, one for its own data (called M4 schema) and one for the
data to be analysed (called the business data schema). However
these two schemas may also be identical.

MiningMart can automatically prepare your database when you 
start it for the first time. It will ask you for connection 
information to your database, the M4 schema and the business 
schema. This information will be written to a file whose name 
you will give; subsequently you do not need to provide this
information again, but it will be read from the file.

Be aware that MiningMart creates a number of tables in the
M4 schema; if tables with identical names happen to exist 
in that schema (for example from an older MiningMart 
installation), they will be deleted! If you want to be sure
you can take a look at the file 
MM_HOME/m4install/oracle/CreateM4Tables.sql to see the table
names that will be deleted and created anew.

If you would like to prepare your Oracle or Postgres database 
manually yourself, you must do a few things explained in the files

MM_HOME/m4install/oracle/README.txt and
MM_HOME/m4install/postgres/README.txt, respectively.

Choose your database system and follow the instructions in the
above-mentioned file.


Chapter 2: Preparing and starting the software
----------------------------------------------

Please see the file MM_HOME/INSTALL. 


Chapter 3: Support
------------------

There is the MiningMart user guide, to be found in the directory
MM_HOME/doc or to be downloaded from the MiningMart website

http://mmart.cs.uni-dortmund.de/

in the downloads section. If you are experiencing troubles during 
installation or running the system, you can send a mail to

miningmart@ls8.cs.uni-dortmund.de

The MiningMart team will attempt to answer your questions as soon
as possible.