added the main page of the documentation

MasWag · Jul 30, 2023 · 72bb158 · 72bb158
1 parent 03cead5
commit 72bb158
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -64,6 +64,7 @@ if(BUILD_DOCUMENTATION)
 
     set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
     set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile)
+    set(doxy_main_page ${CMAKE_CURRENT_SOURCE_DIR}/doc/main.md)
 
     configure_file(${doxyfile_in} ${doxyfile} @ONLY)
 

diff --git a/Doxyfile.in b/Doxyfile.in
@@ -1,4 +1,4 @@
-PROJECT_NAME           = "@CMAKE_PROJECT_NAME@"
+PROJECT_NAME           = "@CMAKE_PROJECT_NAME@ Developers Manual"
 PROJECT_NUMBER         = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ \
                          @PROJECT_BINARY_DIR@

diff --git a/doc/main.md b/doc/main.md
@@ -0,0 +1,6 @@
+Overview
+========
+
+This is the documentation for developers of QTPM. The readers are supposed to be familiar with the concepts and the algorithm in [Waga19].
+
+- [Waga19]: Waga, M. (2019). Online Quantitative Timed Pattern Matching with Semiring-Valued Weighted Automata. In: André, É., Stoelinga, M. (eds) Formal Modeling and Analysis of Timed Systems. FORMATS 2019. Lecture Notes in Computer Science(LNCS), vol 11750. Springer, Cham. https://doi.org/10.1007/978-3-030-29662-9_1