Permalink
Browse files

doc update

  • Loading branch information...
DavidSichau committed Aug 7, 2012
1 parent 017adbe commit 4fd0973399bb566e0f9857c85a223e00cc15ad0d
Showing with 50 additions and 0 deletions.
  1. +8 −0 README
  2. +3 −0 doc/Mainpage.hpp
  3. +39 −0 doc/dependencies.hpp
View
8 README
@@ -0,0 +1,8 @@
To see the documentation and more details on how to install miind-mpi run.
You need to have doxygen installed:
cmake
and then run:
make doc
This generates the html documentation.
For more details see the generated html documentation.
View
@@ -17,6 +17,9 @@ MIIND is free and Open Source. It is distributed under a modified BSD license (s
\section sec_install Installation
Use cmake and make. For more details see \ref installation.
\section sec_dependencies Dependencies
For more details see \ref dependencies
\section MPILib
see \ref MPILibDoc.
View
@@ -0,0 +1,39 @@
/**
\page dependencies Dependencies
<ol>
<li>compilers: see \ref compilers</li>
<li>root: see \ref root</li>
<li>gsl: see http://www.gnu.org/software/gsl/</li>
<li>boost mpi: \ref boost</li>
</ol>
\section compilers Compiler
You need to have a compiler which supports C++11. For example gcc 4.7 or clang 3.1 or later.
You also need to have a mpi compiler like openmpi for compiling the mpi code.
\section root Root
Root needs to be installed with the following flags
\code
./configure --enable-table --enable-explicitlink
make
source /bin/thisroot.sh
\endcode
for more details see http://root.cern.ch/drupal/
\section boost Boost
\code
./bootstrap.sh
\endcode
add the following code to project-config.jam:
\code
using mpi ;
\endcode
and build boost
\code
./b2
./b2 install
\endcode
for more detail see http://www.boost.org/
*/

0 comments on commit 4fd0973

Please sign in to comment.