From eecd8b18e0cd74f96474831ff354165f9793fcf4 Mon Sep 17 00:00:00 2001
From: Marco Luigi Gaibotti <marco.gaibotti@skywarder.eu>
Date: Wed, 19 Feb 2025 20:50:41 +0000
Subject: [PATCH] [documentation] Updated main README

---
 README.md | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 2b4427c9..7aa01b8d 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,8 @@ In order to properly run the msa toolkit code in MATLAB, you will need to instal
 * Parallel Computing Toolbox
 * Statistics and Machine Learning Toolbox
 
+The repository itself contains the necessary tools, while the majority of the data is stored in the common folder, which is a submodule linked to the common repository
+
 ### aerodynamicsOptimization
 This program implements an aerodynamics optimization of the rocket. The rocket is optimized to reach the highest apogee possible with the chosen set of fixed parameters using a genetic algorithm. It may take some time to run.
 
@@ -24,7 +26,7 @@ This program is developed for a primary apogee analysis with different engines w
 
 **Example:**
 ```matlab
-mainApogeeAnalysis(rocket, settings, analysis, plots);
+[standardResults, engineCutResults] = mainApogeeAnalysis(rocket, settings, analysis, plots);
 ```
 
 ### autoMatricesProtub
@@ -32,7 +34,7 @@ This program allows for an automatic computation of the rocket aerodynamic coeff
 
 **Example:**
 ```matlab
-mainAutoMatProtub(rocket, environment, settings);
+[coeffsTot, coeffsTotHighAOA] = mainAutoMatProtub(rocket, environment, settings);
 ```
 
 ### sensitivityAnalysis
@@ -40,7 +42,7 @@ This program implements a sensitivity analysis on the ascent phase of the rocket
 
 **Example:**
 ```matlab
-mainSensitivity(rocket, wind, environment, settings, plots);
+[postProcess, parameters] = mainSensitivity(rocket, wind, environment, settings, plots);
 ```
 
 ### simulator
@@ -48,7 +50,7 @@ This is a program developed in MATLAB for the simulation of 6 D.o.F. rocket dyna
 
 **Example:**
 ```matlab
-mainSimulator(rocket, wind, environment, settings);
+[ascent, descent] = mainSimulator(rocket, wind, environment, settings);
 ```
 
 ### stabilityAnalysis
-- 
GitLab