Changeset 302 for doc/local/install.dox

Show
Ignore:
Timestamp:
03/19/09 16:34:17 (15 years ago)
Author:
smidl
Message:

Install manual ticket #17

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/local/install.dox

    r298 r302  
    66 
    77BDM comes in two basic versions: 
    8 <dl> 
    9  <dt> binary  <dd> with precompiled executables and matlab mex files that can be configured by external text files 
    10  <dt> source code <dd>  that can be compiled into any required form.  
    11   
    12 </dl> 
    13   
    14 \section bin Binary form 
    15  
    16 Distribution of the binary form is not currently available.  
     8\li \b binary   with precompiled executables and matlab mex files that can be configured by external text files 
     9\li \b source \b code  that can be compiled into any required form.  
     10Distribution of the binary form is not currently available. It is planned in latter stages of development. 
    1711 
    1812 
    … …  
    2721 
    2822You need to have the following tools available on your system: 
    29  * working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows 
    30  * CMake a cross-platform build system, http://www.cmake.org 
    31  * ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows. 
     23\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows 
     24\li CMake, a cross-platform build system, http://www.cmake.org 
     25\li ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows. 
    3226  
    33 \subsection lin Linux 
     27\section lin Linux 
    3428 
    3529All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use 
    … …  
    4539\endcode 
    4640 
    47 \subsection win Windows 
     41 
     42\section win Windows 
    4843 
    4944The following approach was tested on Visual Studio 9, so we recommend to download and install it.  
    … …  
    6055make sure to set your PATH environment variable: 
    6156\code 
    62  Path = %PATH%; <mixpp_dir>\win32\dll 
    63  \endcode 
     57 Path = %PATH%; <bdm_dir>\win32\dll 
     58\endcode 
    6459Otherwise you will not be able to run any programs. 
    6560 
    … …  
    7469  directory 
    7570 
     71\section mac Mac OS X 
     72 
     73All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed. 
     74 
     75However, its compilation is straightforward.  
     76 
     77 1. Download the latest stable release from http://itpp.sourceforge.net 
     78 2. Compile it using script mac/itpp_compile.sh 
     79 
     80The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory. 
     81 
     82If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. 
     83Configuration files for your favourite build environment should be created in the BDM directory. 
    7684 
    7785*/