diff --git a/README.md b/README.md index 1475123..8abd6a0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # SCJ_Projekt +# SCJ Projekt + +## Installation + +1. **Aktiviere das Projekt**: + + Wechsel in den **Package Manager** von Julia und aktiviere das Projekt: + + ```julia + ] activate . + ``` +2. **danach die enthaltenen Pakete installieren** + ```julia + ] instantiate + ``` + + +es steht erstmal nur so ein möglicher Projekt Dateiaufbau + +## Nutzung + +Wenn ihr `scripts/run_simulation.jl` ausführt, sollte sich mit **Makie** eine GUI öffnen, die einen **Slider** hat, mit dem man ein paar generierte Frames angucken kann.