Installation

The following instructions come from the INSTALL file included in the source distribution.

Misfit Model 3D Installation
============================

If you are running on Windows see INSTALL.WIN32.  If you are running
on a Unix-like system, installation instructions follow.

Misfit Model 3D requires the following packages for proper operation.  
They are most likely already installed if you have a modern working 
Linux system.

   Qt (3.x or 4.x) with OpenGL support
      http://www.trolltech.com
   OpenGL with GLU (probably Mesa if you are using Linux)
      http://www.mesa3d.org/

For Qt 4.x support, see notes on --with-Qt-dir below.

Even if you have these packages installed you may need to install
development packages as well.  These include header files which are
needed to compile Misfit Model 3D.  Often such packages are marked
as -dev or -devel by your distribution.  For example, sometimes
Qt is broken up into a qt rpm and qt-devel rpm.  In this case, you
must have both installed.

This program uses autoconf and automake for building from source.  What
this means is that if you are lucky you can install this program by
running these commands at a shell prompt (terminal window):

   ./configure
   make
   su [become root]
   make install

On some system configurations you may need to run "sudo bash" instead of
"su" to get a root shell.

On Mac OS X, you must run "make mm3d.app" after "make".

The default PREFIX (install location) is /usr/local.  Files are 
installed in the following directories.

   PREFIX/bin                 - mm3d executable
   PREFIX/share/mm3d/plugins  - plugins
   PREFIX/share/doc/mm3d      - program documentation

You can give ./configure arguments to change how the program is 
compiled.  For example you can change the default install location 
(PREFIX) by specifying --prefix=PATH, where PATH is the new install 
location.

If Qt is not detected and you have it installed, try using --with-Qt-dir
to specify the directory where Qt is installed.  In a default Qt 
installation this is what your QTDIR environment variable is set to.
Include files are in $QTDIR/include and library files are in $QTDIR/lib.

Currently on Unix-like systems you must explicitly use --with-Qt-dir
to specify the location of Qt 4.x (ie, Qt 4.x will not be detected
automatically).

Sometimes development files are in separate paths completely, such as
libs in /usr/lib/qt3 and headers in /usr/include/qt3.  In this case 
use --with-Qt-include-dir=/usr/include/qt3 and 
--with-Qt-lib-dir=/usr/lib/qt3.

If you want to link against a specific library of Qt you can use
--with-Qt-lib=LIBRARY to specify the library.  For example, if
you want to force the multi-threaded Qt library, you would use
--with-Qt-lib=qt-mt

Use ./configure --help for a complete list of options.

If you need installation help you can contact the 
misfitmodel3d-help mailing list at:

   http://www.misfitcode.com/misfitmodel3d/mailinglist.html

You can also email "kevin" at the "misfitcode.com" domain.

Below are generic instructions for installing programs using autoconf
and automake.  They are provided for reference if you need more help
using ./configure.

Basic Installation
==================

   These are generic installation instructions.

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package.

  4. Type `make install' to install the programs and any data files and
     documentation.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files.  Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

   Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System).  The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.

   For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

Specifying the System Type
==========================

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.

Windows Source Installation

The following instructions come from the INSTALL.WIN32 file included in the source distribution.

Misfit Model 3D Installation For Win32
======================================

Misfit Model 3D is known to run on Windows 2000 and Windows XP.
Windows 95, 98, and ME are untested and may or may not work.

Misfit Model 3D for Win32 requires the mingw environment and
the Open Source version of Qt 4 for Win32.  To run binaries
of mm3d you only need the qt and mingw DLLs, which are provided 
with the binary distribution.  To build from source you must
have a development environment set up with mingw and qt4.

Note that plugins are not currently available on Windows.


Binary Installation
===================

Get the latest installer from the web site.  It should have
a filename like 'mm3d-X_X_X-win32-installer.exe'.  Run
the installer and select an install location.

Optionally you may choose to enable file assciations with
Misfit Model 3D.  By default only .mm3d is associated.


Prerequisites
=============

You can get Qt 4 here:

   http://www.trolltech.com/download/qt/windows.html

You can get mingw using Qt 4's binary installer, or download
and install mingw yourself from the official website:

   http://www.mingw.org/

You must have your QTDIR environment variable set to the root
Qt directory (for example, c:\Qt\4.0.1).  The Mingw and Qt bin
directories must be in your path.


Build Instructions
==================

Once you have installed mingw and Qt, do the following steps:

1. Make sure QTDIR is set and mingw's bin directory and Qt's bin
   directory is in your PATH
2. Open a cmd prompt and go to the mm3d-X.X.X directory
3. Run 'mingw32-make -f Makefile.mingw'


Install Instructions
====================

1. Run 'install.bat' from the mm3d-X.X.X directory.

The install.bat file does not create any program menu or desktop 
shortcuts.  If you want shortcuts you must create them manually,
or use the binary installer.

Optionally, you can install NSIS and put the qt and mingw dlls
in your mm3d-X.X.X/dll directory and then build the installer.
This will create shortcuts and some registry keys.

You can get NSIS here:

   http://nsis.sourceforge.net/

Quick Start Installation Guide

Prerequisites

Installation

Windows Source Installation