revised the generated readme file (#41)

precice-forschungsprojekt · Dec 13, 2024 · d25fe46 · d25fe46
1 parent eaa1dd1
commit d25fe46
Showing 1 changed file with 20 additions and 12 deletions.
diff --git a/templates/template_README.md b/templates/template_README.md
@@ -3,33 +3,41 @@
 This `README.md` file was auto-generated by the `FileGenerator.py` script.
 
 ---
-## 🏃‍♂️ Installing the dependencies
 
-To install dependencies and setup the project:
+## 🏃‍♂️ Running the Simulation
 
-# Windows
-```powershell
-.\setup_scripts\install_dependencies.ps1
-```
-# Linux/MacOS
+To run the simulation:
+
+1. Navigate to the `_generated` folder.
+2. Execute the following command:
 
 ```bash
-./setup_scripts/install_dependencies.sh
+bash run.sh
 ```
+or
 
----
+```bash
+chmod +x run.sh
+./run.sh
+```
 
 ---
 
-## 🏃‍♂️ Running the Simulation
+## 🧹 Cleaning the artifacts of the Simulation
 
-To run the simulation:
+To clean up:
 
 1. Navigate to the `_generated` folder.
 2. Execute the following command:
 
 ```bash
-sh run.sh
+bash clean.sh
+```
+or
+
+```bash
+chmod +x clean.sh
+./clean.sh
 ```
 
 ---