From 38071fd8dd477478bd1a046800c258910eae072a Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Tue, 21 Aug 2012 16:23:42 +0200
Subject: [PATCH] README is used as Doxygen index page.
---
README.md | 11 ++++-------
scripts/docs/Doxyfile.in | 4 +++-
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index a398db787ba..57ce457df76 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,7 @@
-# OpenGeoSys 6 #
+OpenGeoSys 6 {#mainpage}
+============
-***This is the source code of the next generation [OpenGeoSys][ogs].***
-
-## The OpenGeoSys-project ##
-
-OpenGeoSys (OGS) is a scientific open source project for the development of
+[OpenGeoSys][ogs] (OGS) is a scientific open source project for the development of
numerical methods for the simulation of thermo-hydro-mechanical-chemical
(THMC) processes in porous and fractured media. OGS is implemented in C++, it
is object-oriented with an focus on the numerical solution of coupled multi-field
@@ -12,7 +9,7 @@ problems (multi-physics). Parallel versions of OGS are available relying on
both MPI and OpenMP concepts. Application areas of OGS are currently CO2
sequestration, geothermal energy, water resources management, hydrology and
waste deposition. OGS is comprised of the THMC-simulator (simply referred to as
-*"OGS"*) and a visualization tool (*"Data Explorer"*). OGS is developed by the
+*OGS*) and a visualization tool (*Data Explorer*). OGS is developed by the
[OpenGeoSys Community][ogs].
## Software development ##
diff --git a/scripts/docs/Doxyfile.in b/scripts/docs/Doxyfile.in
index 94958805606..02bd7fb7931 100644
--- a/scripts/docs/Doxyfile.in
+++ b/scripts/docs/Doxyfile.in
@@ -572,7 +572,9 @@ INPUT = ${CMAKE_SOURCE_DIR}/BaseLib \
${CMAKE_SOURCE_DIR}/FileIO \
${CMAKE_SOURCE_DIR}/GeoLib \
${CMAKE_SOURCE_DIR}/MathLib \
- ${CMAKE_SOURCE_DIR}/MeshLib
+ ${CMAKE_SOURCE_DIR}/MeshLib \
+ ${CMAKE_SOURCE_DIR}/Gui \
+ ${CMAKE_SOURCE_DIR}/README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
--
GitLab