diff --git a/.github/images/banner.png b/.github/images/banner.png new file mode 100644 index 00000000..c9ffd1f8 Binary files /dev/null and b/.github/images/banner.png differ diff --git a/README.md b/README.md index c1fc6b0c..7a9fac43 100644 --- 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 new file mode 100644 index 00000000..b0175951 Binary files /dev/null and b/docs/public/ProjectPresentation.pdf differ diff --git a/docs/src/content/docs/cross-cutting/ProjectPresentation.png b/docs/src/content/docs/cross-cutting/ProjectPresentation.png new file mode 100644 index 00000000..e251b7c2 Binary files /dev/null and b/docs/src/content/docs/cross-cutting/ProjectPresentation.png differ diff --git a/docs/src/content/docs/cross-cutting/project_design_presentation.mdx b/docs/src/content/docs/cross-cutting/project_design_presentation.mdx new file mode 100644 index 00000000..dc795499 --- /dev/null +++ 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. + +
+ + + ![Project Design Presentation](./ProjectPresentation.png) + +