From ec377c749f7cd86f9e9fc76616572188dd102060 Mon Sep 17 00:00:00 2001
From: giuliaghirardini <giulia.ghirardini@skywarder.eu>
Date: Sat, 22 Feb 2025 12:25:29 +0100
Subject: [PATCH] [documentation] Resolved typos
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 3ebc060..8aa555b 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
Common is a **submodule** of msa-toolkit repository.
-A **submodule** is a separated repo, with its own commits and history, of your main project. It is shown as a subdirectory of the main repo, but technically is not just a subdirectory. This is due to the fact that the submodule and the repo are treated separately.
+A **submodule** is a separate repo, with its own commits and history, of your main project. It is shown as a subdirectory of the main repo, but technically is not just a subdirectory. This is due to the fact that the submodule and the repo are treated separately.
-For example, the main repo we are going to use is `msa-toolkit`. This repo has a submodule which is `common` in which are stored all the common files, data and functions used among the departments.
+For example, the main repo we are going to use is `msa-toolkit`. This repo has a submodule which is `common` where all the common files, data, and functions are stored.
<div style="border-left: 4px solid #ffa500; padding: 10px;">
-<strong style="color: #ffa500;">âš Warning:</strong> When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version!
+<strong style="color: #ffa500;">âš Warning:</strong> When working on main repo msa-toolkit be sure which branch/commit your submodule is checked out on. Data and results may be different in simulation if submodule is not updated to latest version!
</div>
@@ -27,10 +27,10 @@ The submodule is divided into four main folders:
* **settings**: this folder only contains `odeConfig.m`, which contains ODE settings.
-<div style="border-left: 4px solid rgb(229, 77, 92); padding: 10px;"><strong style="color:rgb(229, 77, 92)">! Caution:</strong> Don't touch `odeConfig.m` if you don't know what you're doing, from this configuration file depend ode-based script, such ad ballistic.m, and so all the toolkits!.
+<div style="border-left: 4px solid rgb(229, 77, 92); padding: 10px;"><strong style="color:rgb(229, 77, 92)">! Caution:</strong> Don't touch `odeConfig.m` if you don't know what you're doing, from this configuration file depend ODE-based script, such ad `ballistic.m`, and so do all the toolkits!.
</div>
-Inside the mission folder, you can find all the missions and their data and configurations file. Each folder has the name of the mission in a specific format/order. This format is the one you have to use when speficing the mission in `missionConfig.m`.
+Inside the mission folder, you can find all the missions and their data and configurations file. Each folder has the name of the mission in a specific format/order. This format is the one you have to use when specifying the mission in `missionConfig.m`.
```matlab
% YEAR_ROCKETNAME_LOCATION_MONTH
@@ -40,11 +40,11 @@ Inside this folder you will find:
* config: there are four files of config:
- * `environmentConfig.m`: it sets environmental variables for the launch and they are indipendent from the rocket itself (latitude, longitude, ...)
- * `paraConfig.m`: configs for all parachutes onboard of both main and parafoil
+ * `environmentConfig.m`: it sets environmental variables for the launch and they are independent from the rocket itself (latitude, longitude, ...)
+ * `paraConfig.m`: configs for all parachutes onboard, including both the main and parafoil
* `rocketConfig.m`: general parameters of the rocket divided for each bay (nose, parafoil, recovery, ...)
* `windConfig.m`: wind custom and wind matlab configs
-* data: all the `.mat` files are stored; the collect all the data which will be used by toolkits
+* data: all the `.mat` files are stored; they collect all the data which will be used by toolkits
<div style="border-left: 4px solid rgb(30, 139, 255); padding: 10px;"><strong style="color:rgb(30, 139, 255)">â„¹ï¸ Note:</strong> Classes were introduced during the 2024 refactoring of the toolkit! This new architecture enhances robustness, automation, and includes auto-generated documentation for classes.
</div>
--
GitLab