  
Instructions for Compiling & Running DESpot Application
=======================================================
         
This guide contains instructions on how to compile DESpot under Linux,
and Windows.  The Linux instructions are directly below, and the
windows instructions follow them.

You need to use at least QT 4.5.0 to compile DESpot.  DESpot has been
well tested against QT 4.5.2.  If at all possible, you  should use
this version.  However, DESpot should work fine with later versions of
QT.

Once compiled, you can access DESpot's online help browser. From
DESpot, see the "Help > Help contents" to bring up DESpots online 
help.  This will prvoide detailed information on DESpot's capabilities,
and how to use them.


+++++++++++++++++++++++++++++++++++++++++++++++++++++++

LINUX INSTRUCTIONS

+++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
You should make sure the QT development packages are installed.  For
Fedora Linux, the rpms are called: qt-devel 
You should use your distribution's package manager
to install the package (i.e. yum or yumex for Fedora).

You should also make sure you have the C++, g++, compiler installed.
For Fedora Linux, the RPM is called: gcc-c++ 


Steps to compile DESpot using command line 
------------------------------------------
0.  Download the latest tar file of DESpot, as well as the linux
version of the BuDDy  BDD libraries (buddy-2.4Lin.tgz).

1. untar the DESpot  source code that you downloaded 

If the file was "DESpot 1.0.10.tgz"  run the command:

tar xvzf DESpot 1.0.10.tgz

2. untar the BuDDy source code:

tar xvzf buddy-2.4Lin.tgz

3. Configure and compile the BuDDy libraries.    In the buddy-2.4
directory, run as root:

./configure --libdir=/usr/lib --includedir=/usr/include

then:

make

then:

make install

4. From the DESpot source directory run:

qmake-qt4 DESpot.pro

Note that on some Linux distributions there may not be a qmake-qt4
command, but just a "qmake".

5. then type: make release

 This Produces the DESpot binary in the release folder.  If you have 
a multicore cpu (say n cores), you can speeds things up by using 
"make -jn release" to run n compile threads.

6. switch to the release directory: cd release

7. to start DESpot, type: ./DESpot

You should be able to safely copy the DESpot binary to another
directory, but not to your home directory as DESpot will create a
"DESpot" subdirectory (for configuration) in your home directory.

+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Windows INSTRUCTIONS

+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Steps to setup Visual Studio environment 

   1. Download the Express version of Visual Studio C++ 2010 Express and install

http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express

   2. For C++ support, download the windows platform SDK: 

 http://www.microsoft.com/downloads/en/details.aspx?FamilyID=6b6c21d2-2006-4afa-9702-529fa782d63b&displaylang=en 

Though it says Windows 7 it works for Vista and Windows XP Service
Pack 3.  

   3. 1. Download the zip file of the latest version of DESpot
      (i.e. DESpot.1.0.10.zip) and extract it.

   4. Download the latest zip file of the windows version of
      the BuDDy libraries (BuDDy2.4Win.zip).  Extract  the contents
   to the BuDDy subdirectory of your DESpot source code directory.

   If you downloaded your source code to: D:\DESpot.1.0.10,
   you should end up with your Buddy source code in: 
   D:\DESpot.1.0.10\BuDDy\BuDDy2.4Library\

   5. Get Qt 4.5.2 and extract the files.

 http://get.qt.nokia.com/qt/source/qt-win-opensource-src-4.5.2.zip

Open the VS 2010 command window from Tools menu, change to the QT
directory, and type: 

 configure.exe -platform win32-msvc2008 -no-webkit -no-phonon -no-phonon-backend -no-scripttools -no-qt3support -fast

You will be asked which version of QT to use.  You should select only
the opensource version.

then type:  nmake

The above is essentially compiling the QT libs for use with vc++.  It
will likely take quite a while.

   5. Add the  Qt "bin" folder to the windows PATH variable

For current Windows, you can extend PATH using the
Control Panel|System|Advanced|Environment variables menu.

Can also use: right click “My Computer > Properties > Advanced >
Environment Variables”.  

   6. Set the QTDIR environment variable to the root Qt folder  (i.e
      c:\qt\4.5.2-msvc2010 if this is your QT install directory)

Right click “My Computer > Properties > Advanced >
Environment Variables” and add a new variable QTDIR

   7. Open the DESpot.sln file within Visual Studio 

NOTE: You may need to restart VC++ if you already had it open prior to
setting environment vars and compiling Qt 

   8. Build the project from the IDE using "Build\Rebuild Solution"
   menu item.  In the toolbar, you will see a space to select the
   build configuration to use.  Make sure it is set to "release"  and
   not "debug."


In the "release" subdirectory of your DESpot source code directory,
you should find a DESpot.exe binary.  Start this to run DESpot.




