Merge branch 'develop' into 'develop'

add readme.md as start page in doxygen

See merge request irmb/VirtualFluids_dev!61

docs/Doxyfile

@@ -996,7 +996,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = docs/img/
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1052,7 +1052,9 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = main.md
+INPUT += docs/img/VF_logo.png
+INPUT += README.md
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

docs/cpu/Documentation/doc.h

-//index page for doxygen
-
-/*! \mainpage
- *
- *  \section intro_sec Introduction
- *  <i>VirtualFluids</i> is an adaptive, parallel Lattice-Boltzmann flow solver 
- *  which is comprised of various cores 
- *  and use second order accurate compact interpolation at the interfaces, 
- *  coupling grids of different resolutions. 
- *  The software framework is based on object-oriented technology and uses tree-like data structures. 
- *  These data structures are also suitable for hierarchical parallelization using a combination of PThreads and MPI and dynamic load balancing. 
- *   
- *  \section install_sec Installation
- *
- *  \subsection step1 Step 1: CMake
- *  Download and install <a href="http://www.cmake.org/">CMake</a>. 
- *  If you have Windows OS oder X-Windows for Linux/Unix start <i>cmake-gui</i>.
- *  If you work in terminal start <i>ccmake</i>.
- *  \subsection step2 Step 2: project configuration
- *  You need set a path for <i>VirtualFluids</i> source code. It is allays <i>source</i> directory at the end of path.
- *  E.g. c:/vf/source. You need also set a path to build binaries. If you click <b>Configure</b> button start a project wizard and you can choose a compiler.
- *  Set <b>Grouped</b> and <b>Advanced</b> check boxes in CMake. In the group <i>USE</i> you have follow important options:
- *  \li USE_BOND    - using an agent based communication framework for fault tolerance BOND
- *  \li USE_METIS   - using a domain decomposition tool METIS    
- *  \li USE_MPI       - using MPI for distributed memory parallelization   
- *  \li USE_YAML     - using YAML
- *  \li USE_ZOLTAN - using domain decomposition tool ZOLTAN 
- *  There are externals library and you need additionally compile them.    
- *  \subsection step3 Step 4: project compilation
- *  Compile you project with suitable compiler.  
- */
\ No newline at end of file

docs/cpu/Documentation/doc/install.html

-\section install_sec Installation
-
-\subsection step1 Step 1: CMake
-Download and install <a href="http://www.cmake.org/">CMake</a>. 
-If you have Windows OS oder X-Windows for Linux/Unix start <i>cmake-gui</i>.
-If you work in terminal start <i>ccmake</i>.
-\subsection step2 Step 2: project configuration
-You need set a path for <i>VirtualFluids</i> source code. It is allays <i>source</i> directory at the end of path.
-E.g. c:/vf/source. You need also set a path to build binaries. If you click <b>Configure</b> button start a project wizard and you can choose a compiler.
-Set <b>Grouped</b> and <b>Advanced</b> check boxes in CMake. In the group <i>USE</i> you have follow important options:
-\li USE_BOND    - using an agent based communication framework for fault tolerance BOND
-\li USE_METIS   - using a domain decomposition tool METIS    
-\li USE_MPI       - using MPI for distributed memory parallelization   
-\li USE_YAML     - using YAML
-\li USE_ZOLTAN - using domain decomposition tool ZOLTAN 
-There are externals library and you need additionally compile them.    
-\subsection step3 Step 4: project compilation
-Compile you project with suitable compiler.  

docs/cpu/Documentation/doc/intstall.md

-# Installation    {#installation}
-## Step 1: CMake  
-Download and install [CMake](http://www.cmake.org). 
-If you have Windows OS oder X-Windows for Linux/Unix start *cmake-gui*.
-If you work in terminal start *ccmake*.
-## Step 2: project configuration
-You need set a path for *VirtualFluids* source code. It is allays *source* directory at the end of path.
-E.g. *c:/vf/source*. You need also set a path to build binaries. E.g. *c:/vf/bin*. If you click **Configure** button start a project wizard and you can choose a compiler.
-Set **Grouped** and **Advanced** check boxes in CMake. In the group *USE* you have follow important options:
-* USE_BOND    - using an agent based communication framework for fault tolerance BOND
-* USE_METIS   - using a domain decomposition tool METIS    
-* USE_MPI       - using MPI for distributed memory parallelization   
-* USE_YAML     - using YAML
-* USE_ZOLTAN - using domain decomposition tool ZOLTAN  
-
-There are externals library and you need additionally compile them.    
-## Step 4: project compilation
-Compile you project with suitable compiler
\ No newline at end of file

docs/cpu/Documentation/doc/main.md

-# Introduction {#mainpage}
-
-## Introduction
-*VirtualFluids* is an adaptive, parallel Lattice-Boltzmann flow solver 
-which is comprised of various cores 
-and use second order accurate compact interpolation at the interfaces, 
-coupling grids of different resolutions. 
-The software framework is based on object-oriented technology and uses tree-like data structures. 
-These data structures are also suitable for hierarchical parallelization using a combination of PThreads and MPI and dynamic load balancing. 
-
-[Installation](md__d_1__projects__virtual_fluids_source__documentation_doc_intstall.html)

docs/cpu/Documentation/doxygen/start.html

-<meta http-equiv="refresh" content="0; URL=html/index.html">
\ No newline at end of file