Changeset 302 for doc/html/install.html

Timestamp:

03/19/09 16:34:17 (15 years ago)

Author:

smidl

Message:

Install manual ticket #17

Files:

• doc/html/install.html (modified) (2 diffs)

doc/html/install.html

@@ -60 +60 @@
 <div class="contents">
 <h1><a class="anchor" name="install">How to install BDM </a></h1>BDM is written as a multiplatform library, which was tested on Linux, Windows and Mac OSX. However, installation on each platform is specific.<p>
-BDM comes in two basic versions: <dl>
-<dt>binary </dt>
-<dd>with precompiled executables and matlab mex files that can be configured by external text files </dd>
-<dt>source code </dt>
-<dd>that can be compiled into any required form.<p>
-</dd>
-</dl>
-<h2><a class="anchor" name="bin">
-Binary form</a></h2>
-Distribution of the binary form is not currently available.<h2><a class="anchor" name="src">
+BDM comes in two basic versions: <ul>
+<li><b>binary</b> with precompiled executables and matlab mex files that can be configured by external text files </li>
+<li><b>source</b> <b>code</b> that can be compiled into any required form. Distribution of the binary form is not currently available. It is planned in latter stages of development.</li>
+</ul>
+<h2><a class="anchor" name="src">
 Source code</a></h2>
 is available from svn repository: <a href="http://mys.utia.cas.cz:1800/svn/mixpp">http://mys.utia.cas.cz:1800/svn/mixpp</a><p>
 For download use an appropriate SVN client <a href="http://subversion.tigris.org/links.html#clients">http://subversion.tigris.org/links.html#clients</a><h3><a class="anchor" name="pre">
 Prerequisities</a></h3>
-You need to have the following tools available on your system: working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows CMake a cross-platform build system, <a href="http://www.cmake.org">http://www.cmake.org</a> ITPP library, <a href="http://itpp.sourceforge.net/">http://itpp.sourceforge.net/</a> which is a part of all major linux distributions, for its installation on Windows, see Section Windows.<h3><a class="anchor" name="lin">
-Linux</a></h3>
+You need to have the following tools available on your system: <ul>
+<li>working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows </li>
+<li>CMake, a cross-platform build system, <a href="http://www.cmake.org">http://www.cmake.org</a> </li>
+<li>ITPP library, <a href="http://itpp.sourceforge.net/">http://itpp.sourceforge.net/</a> which is a part of all major linux distributions, for its installation on Windows, see Section Windows.</li>
+</ul>
+<h2><a class="anchor" name="lin">
+Linux</a></h2>
 All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use <div class="fragment"><pre class="fragment">apt-<span class="keyword">get</span> install g++ cmake libitpp-dev 
 </pre></div><p>
@@ -81 +81 @@
 $ cmake .
 $ make
-</pre></div><h3><a class="anchor" name="win">
-Windows</a></h3>
+</pre></div><h2><a class="anchor" name="win">
+Windows</a></h2>
 The following approach was tested on Visual Studio 9, so we recommend to download and install it. <a href="http://www.microsoft.com/express/vc/">http://www.microsoft.com/express/vc/</a><p>
 Make sure you have cmake installed.<p>
 Expert users are advised to download and compile their ITPP version following a guide on : <a href="http://itpp.sourceforge.net/current/installation.html">http://itpp.sourceforge.net/current/installation.html</a><p>
-For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are provided at: <a href="http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip">http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip</a> If you want to use them copy the content of the zip file to win32\ directory and make sure to set your PATH environment variable: <div class="fragment"><pre class="fragment"> Path = %PATH%; &lt;mixpp_dir&gt;\win32\dll
+For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are provided at: <a href="http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip">http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip</a> If you want to use them copy the content of the zip file to win32\ directory and make sure to set your PATH environment variable: <div class="fragment"><pre class="fragment"> Path = %PATH%; &lt;bdm_dir&gt;\win32\dll
 </pre></div> Otherwise you will not be able to run any programs.<p>
 Compilation of BDM:<p>
 When everything is set-up, make a copy of win32/run_cmake.bat, edit it to reflect your environment (i.e. change paths to cmake and your C++ target environment) and run it.<p>
-It should generate build files for your compiler in the main BDM directory </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 17 18:33:03 2009 for mixpp by&nbsp;
+It should generate build files for your compiler in the main BDM directory<h2><a class="anchor" name="mac">
+Mac OS X</a></h2>
+All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed.<p>
+However, its compilation is straightforward.<p>
+1. Download the latest stable release from <a href="http://itpp.sourceforge.net">http://itpp.sourceforge.net</a> 2. Compile it using script mac/itpp_compile.sh<p>
+The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory.<p>
+If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. Configuration files for your favourite build environment should be created in the BDM directory. </div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Thu Mar 19 16:25:43 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>