Doxygen setup

Doxygen/doxyfig

@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "../Eule/"
+INPUT                  = "../Eule/" "input.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. Doxygen uses
@@ -1026,7 +1026,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 = index.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

Doxygen/doxyrun.sh

@@ -1,2 +1,9 @@
+# Copy repository readme here to be used as a cover page
+tail ../readme.md -n +2 > index.md
+
 # Run doxygen
-sudo doxygen eule_doxyfig
+doxygen doxyfig
+
+# Cleanup index.md
+rm -f index.md
+

readme.md

@@ -1,5 +1,5 @@
 # Eule
-Eule is a neat math library used in my C++ projects.
+Eule is a homemade math library, mainly targetted towards computer graphics.
 
 # LICENSE
 ```