From cc2cf4aed69518ff227a1c6adb4e09c6d224cecf Mon Sep 17 00:00:00 2001
From: MuedeHydra <tiger12@gmx.ch>
Date: Fri, 13 Dec 2024 23:04:46 +0100
Subject: [PATCH] update readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 63675f5..798f6ba 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-Hier entsteht der Photonics Helfer.
+# Photonics Helfer
+
+Ein hilfreiches Tool für Photoniker
+
+--- 
+
+## Installation
+### Linux
+
+```sh
+git clone https://gitea.fhgr.ch/zwickethomas/Photonics-Helfer
+cd Photonics-Helfer
+make
+./Photonics-Helfer
+```
+
+### Windows
+
+1) Lade das Repository als zip-Datei herunter.
+2) Entpacke die Datei.
+3) Öffne das cmd und gehe in den Ordner `Photonics-Helper`.
+4) Kompiliere das Programm mit `mingw32-make`.
+5) Starte die Datei `Photonics-Helper.exe`.
+---