Documentation fixed

Doxyfile

-PROJECT_NAME           = "Numerische Strömungssimulation"
-PROJECT_BRIEF          = ""
+PROJECT_NAME           = "Numsimulation"
+PROJECT_BRIEF          = "Numeric flow simulation"
 FILE_PATTERNS          = *.h
 INPUT                  = include
 OUTPUT_DIRECTORY       = documentation
+RECURSIVE              = YES
 
 GENERATE_DOCBOOK       = NO
 GENERATE_HTML          = YES
@@ -10,4 +11,4 @@ GENERATE_LATEX         = NO
 GENERATE_MAN           = NO
 GENERATE_RTF           = NO
 GENERATE_XML           = NO
-NUM_PROC_THREADS       = 0
\ No newline at end of file
+NUM_PROC_THREADS       = 0

README.md

-Template repository suitable for C++, CMake and VS Code stack
+# Numsimulation
+Numsimulation is project developed as part of Numerical Flow Simulation course at RWTH Aachen university. It is a collection of seven software libraries with every one responsible for its own type of problem.
 
-Do not forget to:
- 1. Edit name and date in LICENSE.md
- 2. Edit executable name in launch.json
+### Dependencies
+ - The library depends on [Eigen](https://eigen.tuxfamily.org) for its core functionality.
+ - [CMake](https://cmake.org) is used for compilation and further automation
+ - [Python](https://www.python.org), [NumPy](https://numpy.org) and [Matplotlib](https://matplotlib.org) are used for visualization. 
+ - [Doxygen](https://www.doxygen.nl) is used for generation of documentation
+ - [LaTeX](https://www.latex-project.org) and [Latexmk](https://mg.readthedocs.io/latexmk.html) are used for report generation
+
+### Build
+```
+mkdir build
+cd build
+cmake ..
+cmake --build .
+```
+
+### Usage
+```
+cd build
+cmake --build . --target demo   # Run all tests and visualize results
+cmake --build . --target doc    # Generate documentation
+cmake --build . --target report # Generate report
+```
\ No newline at end of file

include/numsimulation/common.h

@@ -112,4 +112,31 @@ namespace numsimulation
 
     Eigen::Vector2d rotate_cw(Eigen::Vector2d v);   ///< Rotates vector clockwise
     Eigen::Vector2d rotate_ccw(Eigen::Vector2d v);  ///< Rotates vector counterclockwise
-}
\ No newline at end of file
+}
+
+/** @mainpage Numsimulation
+Numsimulation is project developed as part of Numerical Flow Simulation course at RWTH Aachen university. It is a collection of seven software libraries with every one responsible for its own type of problem.
+
+@section Dependencies
+ - The library depends on [Eigen](https://eigen.tuxfamily.org) for its core functionality.
+ - [CMake](https://cmake.org) is used for compilation and further automation
+ - [Python](https://www.python.org), [NumPy](https://numpy.org) and [Matplotlib](https://matplotlib.org) are used for visualization. 
+ - [Doxygen](https://www.doxygen.nl) is used for generation of documentation
+ - [LaTeX](https://www.latex-project.org) and [Latexmk](https://mg.readthedocs.io/latexmk.html) are used for report generation
+
+@section Build
+@code{.sh}
+mkdir build
+cd build
+cmake ..
+cmake --build .
+@endcode
+
+@section Usage
+@code{.sh}
+cd build
+cmake --build . --target demo   # Run all tests and visualize results
+cmake --build . --target doc    # Generate documentation
+cmake --build . --target report # Generate report
+@endcode
+*/
\ No newline at end of file