Skip to content

Commit

Permalink
Improve the description of the compilation step in the INSTALL file a…
Browse files Browse the repository at this point in the history
…nd the Blaze tutorial
  • Loading branch information
igl42 committed Aug 24, 2012
1 parent f968f76 commit 67be7d4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
14 changes: 9 additions & 5 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ vi ./Configfile
In the 'Configfile', the kind of installation (debug or release), the library types (static and/or
dynamic), the compiler including compiler flags, and several include paths have to be specified.
Afterwards, the 'configure' script can be run, which uses the 'Configfile' to update and create
several files:
several files (including header files):

./configure

Expand All @@ -53,7 +53,10 @@ Windows Users
-------------

Unfortunately, for Windows users there is no 'configure' script available (yet). Therefore Windows
users have to manually configure the Blaze library in the './blaze/config/' subdirectory.
users have to manually configure the Blaze library. Most configuration headers are located in the
'./blaze/config/' subdirectory. The one exception is the 'BLAS.h' header in the './blaze/system/'
subdirectory that contains the configuration of the BLAS functionality. Note that in case the
'BLAZE_BLAS_MODE' symbol is set to 1, the correct BLAS header file has to be specified!


Step 2: Installation
Expand Down Expand Up @@ -99,9 +102,10 @@ Step 3 (Optional): Compilation
Linux/MacOSX Users
------------------

If certain extended functionality, such as for instance blaze::ThreadPool or the blaze::logging
functionality, is required, it is necessary to create the Blaze library files. For that purpose,
the 'configure' script has created a 'Makefile' that can be used for the compilation process:
Next to the math library, Blaze also contains a small number of additional (sub-)libraries. If
these libraries, such as blaze::ThreadPool or the blaze::logging functionality, are required
it is necessary to create the Blaze library files. For that purpose, the 'configure' script has
created a 'Makefile' that can be used for the compilation process:

make

Expand Down
15 changes: 9 additions & 6 deletions blaze/Blaze.h
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,11 @@ namespace blaze {}
// \n \subsection step_1_configuration_windows Windows User
//
// Unfortunately, for Windows users there is no \c configure script available (yet). Therefore
// Windows user have to manually configure the \b Blaze library in the <em>./blaze/config/</em>
// subdirectory.
// Windows user have to manually configure the \b Blaze library. Most configuration headers are
// located in the <em>./blaze/config/</em> subdirectory. The one exception is the \c BLAS.h
// header in the <em>./blaze/system/</em> subdirectory that contains the configuration of the
// BLAS functionality. Note that in case the \c BLAZE_BLAS_MODE symbol is set to 1, the correct
// BLAS header file has to be specified!
//
//
// \n \section step_2_installation Step 2: Installation
Expand Down Expand Up @@ -212,10 +215,10 @@ namespace blaze {}
//
// \subsection step_3_configuration_unix Linux/MacOSX User
//
// If certain extended functionality, such as for instance blaze::ThreadPool or the blaze::logging
// functionality, is required, it is necessary to create the \b Blaze library files. For that
// purpose, the \c configure script has created a \c Makefile that can be used for the compilation
// process:
// Next to the math library, \b Blaze also contains a small number of additional (sub-)libraries.
// If these libraries, such as blaze::ThreadPool or the blaze::logging functionality, are required
// it is necessary to create the \b Blaze library files. For that purpose, the \c configure script
// has created a \c Makefile that can be used for the compilation process:
\code
make
Expand Down

0 comments on commit 67be7d4

Please sign in to comment.