From 8d9b540c818637dd72d02fb9ab7349007d7d6e02 Mon Sep 17 00:00:00 2001
From: 2mal3 <56305732+2mal3@users.noreply.github.com>
Date: Sat, 8 Nov 2025 23:51:44 +0100
Subject: [PATCH] docs: rough architecture documentation

---
 CONTRIBUTING.md | 23 +++++++++++++++++++++++
 README.md       |  4 ++++
 2 files changed, 27 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2e0dab0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing
+
+## Development
+
+### Architecture
+
+The software suite comprises two main components that are designed to work together on the same network.
+The _Display Block_ is responsible for displaying content on a monitor.
+The _Control Block_ controls multiple Display Blocks via a user interface. One Display Block can be controlled by multiple Control Blocks.
+
+- `control/`: Go code for the Control Block.
+  - `frontend/`: The actual frontend written in SvelteKit.
+- `display/`: Go code for the Display Block.
+- `nixos/`: NixOS configuration for a self-updating, ready-to-use Linux system for the Display Block. This is not necessary for using PLG-MuDiCS.
+- `shared/`: Shared code and assets for the Control and Display Block.
+
+### Technologies
+
+- **Go** for the base code in both the Control and Display Block.
+- **SvelteKit** in prerender mode for the frontend of the Control Block.
+- **TailwindCSS** for styling the frontend of the Control Block.
+- **Chromium** browser for handling most media display in the Display Block and serving the frontend of the Control Block.
+- **LibreOffice** for handling more complex documents in the Display Block.
diff --git a/README.md b/README.md
index d4a1cba..0915aae 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,7 @@
 # PLG-MuDiCS
 
 ![Lines of Code](https://tokei.rs/b1/github/PLG-Development/PLG-MuDiCS?category=code)
+
+## Contributing
+
+See [Contributing.md](/CONTRIBUTING.md)