Changeset 983 for library/doc/tutorial/000install.dox

Timestamp:

05/25/10 22:33:29 (14 years ago)

Author:

smidl

Message:

doc - extensions

Files:

• library/doc/tutorial/000install.dox (modified) (6 diffs)

library/doc/tutorial/000install.dox

@@ -6 +6 @@
 
 BDM comes in two basic versions:
-\li \b binary   with precompiled executables and matlab mex files that can be configured by external text files
-\li \b source \b code  that can be compiled into any required form. 
+ - \b binary   with precompiled executables and matlab mex files that can be configured by external text files
+ - \b source \b code  that can be compiled into any required form. 
 
 \section in_bin Binaries for BDMtoolbox
@@ -13 +13 @@
 
 Installation:
-\li svn checkout http://mys.utia.cas.cz:1800/svn/mixpp/applications/bdmtoolbox/ into your local directory of your choice (this will be denoted \<toolbox_dir\>)
-\li or download a prepared zip file from http://staff.utia.cas.cz/smidl/Public/bdmtoolbox_win32.zip and extract it to any directory (will be denoted \<toolbox_dir\>)
-\li open matlab and type:
+ - svn checkout http://mys.utia.cas.cz:1800/svn/mixpp/applications/bdmtoolbox/ into your local directory of your choice (this will be denoted \<toolbox_dir\>)
+ - or download a prepared zip file from http://staff.utia.cas.cz/smidl/Public/bdmtoolbox_win32.zip and extract it to any directory (will be denoted \<toolbox_dir\>)
+ - open matlab and type:
 \code 
 >> addpath <toolbox_dir>/mex; 
@@ -29 +29 @@
 \endcode
 For linux, the default build dir is \<toolbox_dir\>/mex, hence only me and mex_classes need to be in the path.
-\li the toolbox is ready to be used, test it e.g. by: 
+ - the toolbox is ready to be used, test it e.g. by: 
 \code >> cd tutorial/userguide; 
 >> pdfds_example \endcode
-\li if no error is given, the toolbox is installed correctly
-\li proceed to tutorial at http://mys.utia.cas.cz:1800/trac/bdm/doxygen/pages.html to learn how to use it
+ - if no error is given, the toolbox is installed correctly
+ - proceed to tutorial at http://mys.utia.cas.cz:1800/trac/bdm/doxygen/pages.html to learn how to use it
 
 \section src Source code
@@ -47 +47 @@
 
 You need to have the following tools available on your system:
-\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows
-\li CMake, a cross-platform build system, http://www.cmake.org
+ - working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows
+ - CMake, a cross-platform build system, http://www.cmake.org
  
 \section lin Linux
@@ -89 +89 @@
 Compilation of BDM:
 
- * When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it 
+ - When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it 
   to reflect your environment (i.e. change paths to cmake and your C++ target environment) 
   and run it.
 
- * Alternatively, you can run CMake GUI and specify address to your \<bdm_dir\>
+ - Alternatively, you can run CMake GUI and specify address to your \<bdm_dir\>
 
 
- * It should generate build files for your compiler in the main BDM 
+ - It should generate build files for your compiler in the main BDM 
   directory
 
@@ -108 +108 @@
 
 Right now, Cmake configuration is hard-coded for one testing machine. Look for the paths in SetBDMEnv.cmake and correct them.
-Open CMake GUI, clisk Configure followed by Create.
+Open CMake GUI, click Configure followed by Create.
 Configuration files for your favourite build environment should be created in the BDM directory.