From 5cb80484acfe3eb5ca1467da5163bcbc6a767e0e Mon Sep 17 00:00:00 2001
From: tamaf96 <tamaf96@mi.fu-berlin.de>
Date: Tue, 16 Aug 2022 10:52:24 +0200
Subject: [PATCH] README, run.sh hinzufuegen/ ueberarbeiten

---
 README    |  5 -----
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 run.sh    | 11 +++++++++++
 3 files changed, 56 insertions(+), 5 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md
 create mode 100755 run.sh

diff --git a/README b/README
deleted file mode 100644
index 7d10ad4..0000000
--- a/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Zum compilieren:
-mpicc -lm -o weltraum weltraumschrottmodell.c
-
-Zum ausführen lokal:
-mpirun -np 3 ./weltraum
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..258a982
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+Das Programm Weltraumschrott.c dient als reiner proof of concept und ist nicht frei von Fehlern.
+Zum Bauen und ausführen wird folgendes benötigt:
+ - MPI/MPICH
+ - ffmpeg
+ - python 3
+
+ Zum Bauen und Ausführen gibt es folgendes Script in 2 Versionen:
+ run.sh (ohne Paramater)
+ run.sh --debug (löscht die Zwischendateien nicht)
+
+ Das Script ruft die Folgenden Befehle nacheinander auf:
+
+Zum compilieren:
+`mpicc -lm -o weltraum weltraumschrottmodell.c`
+
+Zum ausführen lokal:
+`mpirun -np 3 ./weltraum`
+
+Output zusammenbasteln:
+`python combine.py`
+
+Visualisierung:
+`python visualization.py`
+
+Video erstellen:
+`ffmpeg -r 60 -f image2 -s 1920x1080 -i picture%d.png -vcodec libx264 -crf 25  -pix_fmt yuv420p -loglevel error video.mp4`
+
+Alle Zwischenprodukte löschen:
+`rm picture*.png`
+`rm *result.csv`
+
+
+Das Programm selbst nimmt keine Parameter entgegen.
+Man kann die folgenden Stellschrauben in der c-Datei verändern:
+
+MAX_X: Maximale Breite der Fläche
+MAX_Y: Maximale Höhe der Fläche
+SPAWN: Anzahl neuer Objekte bei Kollision
+t: Anzahl berechneter Zeiteinheiten
+
+Folgende Stellschrauben müssen in der input.csv Datei angepasst werden:
+
+Anzahl der Startobjekte und deren Eigenschaften.
+Pro Zeile ein Objekt, lies: Koord_x, koord_y, mass, richtung_x, richtung_y
+
diff --git a/run.sh b/run.sh
new file mode 100755
index 0000000..ee2a4d3
--- /dev/null
+++ b/run.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+mpicc -lm -o weltraum weltraumschrottmodell.c
+mpirun -np 3 ./weltraum
+python combine.py
+python visualization.py
+ffmpeg -r 60 -f image2 -s 1920x1080 -i picture%d.png -vcodec libx264 -crf 25  -pix_fmt yuv420p -loglevel error video.mp4
+rm picture*.png
+if [[ $* != *--debug* ]]; then
+    rm *result.csv
+fi
-- 
GitLab