doxy: use readme as main page

README.md

@@ -9,9 +9,10 @@ This library provides a framework for handling multi dimensional containers, the
 The library can be installed by the following procedure (`gtest` required):
 
 ```bash
-git clone git@git.f3l.de:chizeta/cnorxz.git <SOURCE_DIR>
+git clone git@git.f3l.de:chizeta/cnorxz.git <LIBRARY_ROOT_DIR>
+mkdir <BUILD_DIR>
 cd <BUILD_DIR>
-cmake -DCMAKE_INSTALL_PREFIX:PATH=<INSTALL_DIR> <SOURCE_DIR>
+cmake -DCMAKE_INSTALL_PREFIX:PATH=<INSTALL_DIR> <LIBRARY_ROOT_DIR>
 make install
 ```
 
@@ -31,7 +32,7 @@ The tools of the library are accessible within the namespace `CNORXZ`.
 
 (Also consider doxygen)
 
-### Basics
+### Basics and Library organization
 
 This library consists of several building blocks. For simple usage, the most important building blocks are [ranges](#ranges), [indices](#indices) and [array types](#arrays).
 
@@ -63,8 +64,11 @@ Apart from range specific indices, there exist also special indices:
 
 * `BIndex<T>` : The same as `AIndex`, but not const.
 
-#### Arrays
+#### Array types
 
 Finally, there are the container classes (arrays), which are derived from `CArrayBase<T>` (const) or `ArrayBase<T>` for a given data type `T`. All arrays are defined on a range, their data can be accessed or iterated over using suitable indices. The array-type actually containing data is called `MArray<T>`. Moreover, there exist array-types that do not contain data, but view the data of other arrays or at least parts of the data. These are called `CSlice<T>` (const view) or `Slice`.
 
+#### Expressions and Operations
+
+...
 

doc/doxy/Doxyfile

@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src
+INPUT                  = ../../README.md ../../src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1110,7 +1110,7 @@ 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 =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common

src/include/cnorxz.h

@@ -9,19 +9,6 @@
    
 **/
 
-/**
-    @mainpage CNORXZ Documentation
-
-    ## Library organization
-    
-    ## Ranges and Indices
-
-    ## Array types
-
-    ## Expressions and Operations
-    
- **/
-
 #ifndef __cxz_cnorxz_h__
 #define __cxz_cnorxz_h__