aboutsummaryrefslogtreecommitdiff
path: root/docs/share
diff options
context:
space:
mode:
Diffstat (limited to 'docs/share')
-rw-r--r--docs/share/footer.adoc4
-rw-r--r--docs/share/glossary.adoc10
-rw-r--r--docs/share/meta.adoc43
-rw-r--r--docs/share/references.adoc5
-rw-r--r--docs/share/refs.bib194
5 files changed, 256 insertions, 0 deletions
diff --git a/docs/share/footer.adoc b/docs/share/footer.adoc
new file mode 100644
index 0000000..b3edec3
--- /dev/null
+++ b/docs/share/footer.adoc
@@ -0,0 +1,4 @@
+include::references.adoc[]
+
+include::glossary.adoc[]
+
diff --git a/docs/share/glossary.adoc b/docs/share/glossary.adoc
new file mode 100644
index 0000000..871a8e9
--- /dev/null
+++ b/docs/share/glossary.adoc
@@ -0,0 +1,10 @@
+[appendix]
+== Glossary
+
+[glossary]
+RPI:: Raspberry Pi
+Main board:: The main board is the PCB on the bottom of the puzzle box, this communicates with the puzzles and the bomb
+Puzzle box hub:: The puzzle box hub communicates with the puzzle box and the bomb, as well as helps with configuring them
+SID:: security identifiers
+game operator:: person who organizes a puzzle box play session
+
diff --git a/docs/share/meta.adoc b/docs/share/meta.adoc
new file mode 100644
index 0000000..2e15b79
--- /dev/null
+++ b/docs/share/meta.adoc
@@ -0,0 +1,43 @@
+// (these files are included from the parent directory)
+:pdf-theme: ./theme.yml
+// :pdf-fontsdir: ./res/font
+:bibtex-file: ./share/refs.bib
+
+// document / project info
+ifndef::document[]
+:document: DOCUMENT TITLE
+endif::[]
+:project: Project Puzzlebox
+:revnumber: 0.0
+:revdate: 2024-04-01
+:revremark: draft
+:author_1: Thomas in ‘t Anker
+:author_2: Loek Le Blansch
+:author_3: Lars Faase
+:author_4: Elwin Hammer
+
+// numbering / reference styles
+:sectnums:
+:toclevels: 4
+:pagenums:
+:xrefstyle: short
+
+// (set and display title)
+= {document}: {project}
+// start each document with a title page
+:title-page:
+// followed by a table of contents
+:toc:
+
+[discrete]
+== List of Figures
+list-of::image[]
+
+[discrete]
+== List of Tables
+list-of::table[]
+
+<<<
+
+// also https://docs.asciidoctor.org/asciidoc/latest/attributes/document-attributes-ref
+
diff --git a/docs/share/references.adoc b/docs/share/references.adoc
new file mode 100644
index 0000000..e7f5b61
--- /dev/null
+++ b/docs/share/references.adoc
@@ -0,0 +1,5 @@
+[appendix]
+== References
+
+bibliography::[]
+
diff --git a/docs/share/refs.bib b/docs/share/refs.bib
new file mode 100644
index 0000000..b6fe625
--- /dev/null
+++ b/docs/share/refs.bib
@@ -0,0 +1,194 @@
+% see https://tug.ctan.org/info/biblatex-cheatsheet/biblatex-cheatsheet.pdf
+
+@online{githubprojects,
+ title = {About Projects - GitHub Docs},
+ url = {https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects},
+ msbib-accessed = {2024-02-15},
+ year = {2024},
+}
+
+@online{clockify,
+ title = {Clockify - The most popular free time tracker for teams},
+ url = {https://clockify.me/},
+ msbib-accessed = {2024-02-15},
+ year = {2024},
+}
+
+@online{gitscm,
+ title = {Git},
+ url = {https://git-scm.com/},
+ month = feb,
+ msbib-day = {15},
+ year = {2024},
+}
+
+@online{Kee23,
+ title = {Keep talking and nobody explodes - defuse a bomb with your friends.},
+ url = {https://keeptalkinggame.com/},
+ month = oct,
+ msbib-day = {10},
+ year = {2023},
+}
+
+@online{gitrepo,
+ author = {Blansch, Loek Le and Hammer, Elwin and Faase, Lars and in 't Anker, Thomas},
+ title = {lonkaars/puzzelbox: Avans Hogeschool project Puzzelbox},
+ url = {https://github.com/lonkaars/puzzelbox},
+ month = feb,
+ msbib-day = {15},
+ year = {2024},
+}
+
+@online{sharepoint,
+ author = {Blansch, Loek Le and Hammer, Elwin and Faase, Lars and in 't Anker, Thomas},
+ title = {PROJ-PUZZLE},
+ url = {https://avans-my.sharepoint.com/:f:/r/personal/tv_intanker_student_avans_nl/Documents/PROJ-PUZZLE?csf=1&web=1&e=wbKFig},
+ month = feb,
+ msbib-day = {15},
+ year = {2024},
+}
+
+@online{semver,
+ author = {Preston-Werner, Tom},
+ title = {Semantic Versioning 2.0.0},
+ url = {https://semver.org/},
+ month = jun,
+ msbib-day = {6},
+ year = {2023},
+}
+
+@online{atlassiankanban,
+ author = {Radigan, Dan},
+ title = {Kanban - A brief introduction},
+ url = {https://www.atlassian.com/agile/kanban},
+ msbib-accessed = {2024-02-15},
+ year = {2024},
+}
+
+@techreport{Bek23,
+ author = {Bekema, Frank and Gense, Jasper},
+ title = {Programma van Eisen Puzzel box},
+ year = {2023},
+}
+
+@techreport{styleguide,
+ author = {Blansch, Loek Le and Hammer, Elwin and Faase, Lars and in 't Anker, Thomas},
+ title = {Style guide},
+ location = {'s-Hertogenbosch},
+ publisher = {Avans University of Applied Sciences},
+ year = {2024},
+}
+
+@online{Wik22,
+ author = {Wikipedia-contributors},
+ title = {MOSCOW-Methode},
+ url = {https://nl.wikipedia.org/wiki/MoSCoW-methode},
+ month = apr,
+ msbib-day = {5},
+ year = {2022},
+}
+
+@online{rpicpu,
+ url = {https://www.raspberrypi.com/documentation/computers/processors.html},
+}
+
+@online{Ali24,
+ title = {A list of open-source C++ libraries},
+ url = {https://en.cppreference.com/w/cpp/links/libs},
+ msbib-accessed = {2024-02-25},
+}
+
+@online{Boo24,
+ title = {Boost.Test - 1.75.0},
+ url = {https://www.boost.org/doc/libs/1_75_0/libs/test/doc/html/index.html},
+ msbib-accessed = {2024-02-28},
+}
+
+@online{Git24,
+ title = {GitHub - boostorg/test: The reference C++ unit testing framework (TDD, xUnit, C++03/11/14/17).},
+ url = {https://github.com/boostorg/test},
+ msbib-accessed = {2024-02-28},
+}
+
+@online{Neo,
+ title = {Neotrellis},
+ url = {https://learn.adafruit.com/adafruit-neotrellis/overview},
+}
+
+@techreport{rp2040ds,
+ title = {RP2040 Datasheet},
+ publisher = {Raspberry Pi Ltd},
+ year = {2024},
+}
+
+@online{Cat24,
+ author = {Catchorg},
+ title = {Github - catchorg/Catch2: A modern, C++-native, test framework for unit-tests.},
+ msbib-accessed = {2024-02-25},
+}
+
+@online{Cpp24,
+ author = {Cpputest},
+ title = {Github - cpputest/cpputest: CppUTest unit testing and mocking framework for C/C++.},
+ url = {https://github.com/cpputest/cpputest},
+ msbib-accessed = {2024-02-25},
+}
+
+@online{Doc24,
+ author = {Doctest},
+ title = {Github - doctest/doctest: The fastest feature-rich C++11/14/17/20/23 single-header testing framework.},
+ url = {https://github.com/doctest/doctest},
+ msbib-accessed = {2024-02-25},
+}
+
+@online{goo24,
+ author = {google},
+ title = {GitHub - google/googletest: GoogleTest - Google Testing and Mocking Framework.},
+ url = {https://github.com/google/googletest},
+ msbib-accessed = {2024-02-28},
+}
+
+@online{Joh21,
+ author = {Johnston, P.},
+ title = {Embedded systems testing resources},
+ url = {https://embeddedartistry.com/blog/2018/10/18/embedded-systems-testing-resources/},
+ month = jun,
+ msbib-day = {10},
+ msbib-accessed = {2024-02-25},
+ year = {2021},
+}
+
+@techreport{research,
+ author = {Blansch, Loek Le and Hammer, Elwin and Faase, Lars and in 't Anker, Thomas},
+ title = {Research Document},
+ location = {'s-Hertogenbosch},
+ publisher = {Avans University of Applied Sciences},
+ year = {2024},
+}
+
+@techreport{2021_design,
+ author = {Creemers, Merel and van Wiechen, Joost and Lengowski, Vincent and Maas, Justin},
+ title = {Ontwerpdocument},
+ language = {dutch},
+ location = {'s-Hertogenbosch},
+ publisher = {Avans University of Applied Sciences},
+ year = {2021},
+}
+
+@techreport{2122_handover,
+ author = {van Gastel, Lucas and de Bruin, Julian and Rockx, Toon and van Kuijk, Alex and Baars, Jef},
+ title = {Overdrachtsdocument},
+ language = {dutch},
+ location = {'s-Hertogenbosch},
+ publisher = {Avans University of Applied Sciences},
+ year = {2022},
+}
+
+@techreport{2122_design,
+ author = {van Gastel, Lucas and de Bruin, Julian and Rockx, Toon and van Kuijk, Alex and Baars, Jef},
+ title = {Design document},
+ language = {dutch},
+ location = {'s-Hertogenbosch},
+ publisher = {Avans University of Applied Sciences},
+ year = {2022},
+}