Move software intern documentation to requirements engineering

renn0xtek9 · May 7, 2024 · 91aa4e3 · 91aa4e3
1 parent 394784e
commit 91aa4e3
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 build/*
+documentation/*.bbl 
+documentation/*.blg
diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
@@ -1,16 +1,16 @@
 INCLUDE (CreateLatexDocumentation)
 
-SET (_software_intern_name "software-intern-development")
-SET (SOFTWARE_INTERN_MAIN_TEX ${_software_intern_name}.tex)
+SET (requirements_documents "requirements_document")
+SET (SOFTWARE_INTERN_MAIN_TEX ${requirements_documents}.tex)
 SET (SOFTWARE_INTERN_RESOURCES_FILES
      ${CMAKE_CURRENT_SOURCE_DIR}/resources/project_or_company_logo.png)
 SET (SOFTWARE_INTERN_BIBLIOGRAPHY ${CMAKE_CURRENT_SOURCE_DIR}/library.bib)
 
 CREATELATEXDOCUMENTAION (
-  "${_software_intern_name}" "${SOFTWARE_INTERN_MAIN_TEX}"
+  "${requirements_documents}" "${SOFTWARE_INTERN_MAIN_TEX}"
   "${SOFTWARE_INTERN_RESOURCES_FILES}" "${SOFTWARE_INTERN_BIBLIOGRAPHY}")
 
 ADD_CUSTOM_TARGET (
   documentation
-  DEPENDS ${_software_intern_name}
-  COMMENT "Building documentation")
+  DEPENDS ${requirements_documents}
+  COMMENT "Building requirements documentation")
diff --git a/documentation/README.md b/documentation/README.md
diff --git a/documentation/library.bib b/documentation/library.bib
@@ -1,7 +1,7 @@
 %An article from a magazine or a journal
-@article{uncleDT,
-    author    = {Donald Trump},
-    title     = {Making america great again},
-    journal   = {International Journal of America's greatness},
+@article{fooAuthor,
+    author    = {Foo Bar},
+    title     = {Some title},
+    journal   = {International Journal of Something},
     year      = {2020},
 }
diff --git a/...mentation/software-intern-development.tex → documentation/requirements_document.tex b/...mentation/software-intern-development.tex → documentation/requirements_document.tex
@@ -24,7 +24,7 @@
 \usepackage{algorithmic}
 \usepackage{rotating}
 
-\title{Software internal documentation}
+\title{Requirements}
 \author{Foo Ever}
 \addbibresource{./library.bib} %define so to work with mendeley',
 \setlength{\parindent}{0pt}                % Avoid indentation on the first line',

diff --git a/project/CMakeLists.txt b/project/CMakeLists.txt
@@ -36,3 +36,9 @@ ADD_TEST (
   COMMAND gcovr -r .. --fail-under-line 1.0 --html --html-details -o index.html
   WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 SET_TESTS_PROPERTIES (code_coverage PROPERTIES FIXTURES_CLEANUP unit_tests)
+
+ADD_TEST (
+  NAME benchmarking
+  COMMAND $<TARGET_FILE:probe_benchmark>
+  WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+SET_TESTS_PROPERTIES (benchmarking PROPERTIES DEPENDS benchmark)