META: Add presentation & spice up readme (#56)

smartuni · May 2, 2024 · 0344788 · 0344788
2 parents 59d0b52 + d42b557
commit 0344788
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/.github/images/banner.png b/.github/images/banner.png
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
-# Teamagochi - ティーマゴチ
+![Teamagochi - てぃーまごっち](./.github/images/banner.png)
 
 ## Description
 
-Teamagochi is a virtual pet project by the RIOT Project SoSe24 team.
+Teamagochi is a synchronized always-online pet simulator with multiplayer functionality by the RIOT Project SoSe24 team. 
+
+It consists of a [physical device (Node)](./node/), [web backend](./web_backend/) and [web/mobile frontend](./web_backend/).
 
 ### [Documentation Page](https://smartuni.github.io/teamagochi/)
 

diff --git a/docs/public/ProjectPresentation.pdf b/docs/public/ProjectPresentation.pdf
diff --git a/docs/src/content/docs/cross-cutting/ProjectPresentation.png b/docs/src/content/docs/cross-cutting/ProjectPresentation.png
diff --git a/docs/src/content/docs/cross-cutting/project_design_presentation.mdx b/docs/src/content/docs/cross-cutting/project_design_presentation.mdx
@@ -0,0 +1,16 @@
+---
+title: Project Design Presentation
+description: Presentation of the project design.
+---
+
+The project design presentation is a high-level overview of the project design.
+It is intended to provide a quick overview of the project design to stakeholders, project managers, and developers. 
+
+The presentation can be accessed [HERE](/teamagochi/ProjectPresentation.pdf) or by clicking on the image below.
+
+<br />
+
+<a href="/teamagochi/ProjectPresentation.pdf">
+    ![Project Design Presentation](./ProjectPresentation.png)
+</a>
+