[doc] Added main page to documentation

Doxyfile

@@ -140,7 +140,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -459,7 +459,7 @@ EXTRACT_LOCAL_METHODS  = NO
 # are hidden.
 # The default value is: NO.
 
-EXTRACT_ANON_NSPACES   = NO
+EXTRACT_ANON_NSPACES   = YES
 
 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
 # undocumented members inside documented classes or files. If set to NO these
@@ -519,13 +519,13 @@ HIDE_SCOPE_NAMES       = NO
 # YES the compound reference will be hidden.
 # The default value is: NO.
 
-HIDE_COMPOUND_REFERENCE= NO
+HIDE_COMPOUND_REFERENCE= YES
 
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
 
-SHOW_INCLUDE_FILES     = YES
+SHOW_INCLUDE_FILES     = NO
 
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
 # grouped member an include statement to the documentation, telling the reader
@@ -647,14 +647,14 @@ MAX_INITIALIZER_LINES  = 30
 # list will mention the files that were used to generate the documentation.
 # The default value is: YES.
 
-SHOW_USED_FILES        = YES
+SHOW_USED_FILES        = NO
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
 # will remove the Files entry from the Quick Index and from the Folder Tree View
 # (if specified).
 # The default value is: YES.
 
-SHOW_FILES             = YES
+SHOW_FILES             = NO
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
 # page. This will remove the Namespaces entry from the Quick Index and from the
@@ -1638,7 +1638,7 @@ MAKEINDEX_CMD_NAME     = makeindex
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-COMPACT_LATEX          = NO
+COMPACT_LATEX          = YES
 
 # The PAPER_TYPE tag can be used to set the paper type that is used by the
 # printer.

src/mainpage.dox

@@ -0,0 +1,65 @@
+/*! \mainpage
+ *
+ * \section intro_sec Einführung
+ *
+ * Die Carpe Diem-Distribution ist für die Installation unter Ubuntu Linux in der
+ * Version 16.04.1 LTS konzipiert. Zunächst sollte sichergestellt werden, dass die
+ * Grafikkartentreiber des Herstellers installiert sind. Dazu wird das unter Ubuntu
+ * standardmäßig verfügbare Programm <em>Zusätzliche Treiber</em> aufgerufen.
+ * 
+ * \subsection drivers Gerätetreiber
+ * Für NVIDIA-Grafikkarten
+ * sollte die neueste Version des <em>NVIDIA binary driver</em> ausgewählt und
+ * installiert werden. Für OpenCL-Unterstützung ist noch die Installation des Paketes
+ * <code>nvidia-opencl-icd-3xx</code> erforderlich, wobei 3xx für die ersten drei Ziffern
+ * der Versionsnummer des Grafiktreibers steht.
+ * 
+ * Der Treiber für AMD-Grafikkarten muss entsprechend der Anleitung von
+ * <a href="http://support.amd.com/en-us/kb-articles/Pages/AMDGPU-PRO-Install.aspx">AMD</a>
+ * manuell installiert werden. Ab Ubuntu 16.04 wird nur noch der AMDGPU- bzw. AMDGPU-PRO-Treiber
+ * unterstützt. Die ältere Version <code>fglrx</code> kann nicht mehr verwendet werden.
+ * 
+ * Mithilfe des Programms <code>clinfo -l</code> kann überprüft werden, ob die Installation
+ * der Treiber erfolgreich war bzw. ob die Grafikkarte für OpenCL-Berechnungen zur Verfügung steht.
+ * Ist die gewünschte Grafikkarte nicht das Device 0 unter der Platform 0, sollte eine Datei
+ * mit dem folgenden Inhalt (entspr. Device- und Platformnummer einfügen) unter <code>~/.cn24/config.json</code> angelegt werden:
+ *
+ * <code>
+ *
+ * {
+ * 	"opencl_platform": 1,
+ * 	"opencl_device": 2
+ * }
+ *
+ * </code>
+ * 
+ * 
+ * Notfalls ist Carpe Diem auch ohne OpenCL lauffähig. Diese Situation wird vom Installationsskript automatisch
+ * erkannt und berücksichtigt.
+ * 
+ * \section install_sec Installation
+ * Die Distribution von Carpe Diem besteht unter anderem aus den folgenden Dateien und Ordnern:
+ * <ul>
+ * 	<li> <code>cn24</code> --- der Quellcode von CN24</li>
+ * 	<li> <code>carpediem</code> --- der Quellcode von Carpe Diem</li>
+ * 	<li> <code>JPEGImages</code> --- Bilder, die dem mitgelieferten Modell bekannt sind (werden für Training benötigt)</li>
+ * 	<li> <code>project</code> --- Beispielprojekt</li>
+ * 	<li> <code>install.sh</code> --- Installationsskript</li>
+ * 	<li> <code>carpediem.sh</code> --- Startet Carpe Diem nach erfolgter Installation</li>
+ * </ul>
+ * 
+ * Um Carpe Diem zu installieren, muss das Skript <code>install.sh</code> aufgerufen werden.
+ * Zunächst installiert das Skript alle in der Datei <code>packages</code> aufgezählten
+ * Abhängigkeiten. Dazu werden Superuserrechte benötigt. Alle übrigen Operationen werden
+ * als normaler Benutzer ausgeführt. Anschließend wird ermittelt, ob eine OpenCL-fähige
+ * Grafikkarte existiert. CN24 und Carpe Diem werden mit entsprechenden Einstellungen
+ * kompiliert. Danach wird die Testsuite von CN24 ausgeführt, um die korrekte Funktion
+ * zu überprüfen. Falls Fehler während der Installation auftreten, bricht das Skript ab und weist auf
+ * die entsprechenden Logdateien hin.
+ * 
+ * Einige Dateien werden in den globalen CN24-Order <code>~/.cn24</code> kopiert bzw.
+ * verknüpft. So können Projekte verschoben oder kopiert werden, ohne dass z.B.
+ * Datensätze mitbewegt werden müssen.
+ * 
+ * Carpe Diem kann nun aus dem Distributionsorder mit <code>./carpediem.sh</code> gestartet werden.
+ */