diff --git a/README.md b/README.md index e07a9e3..4308ece 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ # Setup -Diverse Skripte um einen Rechner aufzusetzen. \ No newline at end of file +## Übersicht + +Dieses Repository enthält Skripte um ein Linux System mit Hyprland und diversen Programmen aufzusetzen. +Die entsprechenden Skripte befinden sich in den Branches zur jeweiligen Distribution. + +## Anforderungen + +Um die Skripte in diesem Repository auszuführen, stelle sicher, dass die folgenden Voraussetzungen erfüllt sind: + +- Die Skripte sind als bash-Skripte konzipiert. +- Für die Skripte muss der richtige Branch der jewiligen Distribution ausgewählt werden. +- Daten werden vor der Ausführung nicht gesichert. Datenverlust möglich! + +## Nutzung + +1. Klone das Repository: + ```bash + git clone https://gitea.creative-dragonslayer.de/DragonSlayer_14/Setup.git + ``` +2. Wechsle in den richtigen Branch. +3. Navigiere in das Verzeichnis `Setup`, um die ausführbaren Dateien und Ressourcen zu finden. +4. Folge den spezifischen Anweisungen in einzelnen Dateien oder Skripten für die korrekte Ausführung. + +## Lizenz + +Dieses Projekt steht unter einer Open-Source-Lizenz. Weitere Informationen findest du in der Datei `LICENSE`. + +## Autor + +Erstellt und gepflegt von DragonSlayer_14.