From c74d8d4227719f831ba3526aada7c8f63266f32c Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giulia.ghirardini@skywarder.eu> Date: Fri, 21 Feb 2025 22:36:04 +0100 Subject: [PATCH] [documentation] GitLab Flavored Markdown (GLFM) does not support the [!ALERT] syntax. Used HTML instead --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c39950a..3ebc060 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ A **submodule** is a separated repo, with its own commits and history, of your m 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. -> [!WARNING] -> 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! -> + +<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! +</div> + ## Submodule architecture @@ -23,10 +25,10 @@ The submodule is divided into four main folders: mission.name = '2025_Orion_Portugal_October'; ``` * **settings**: this folder only contains `odeConfig.m`, which contains ODE settings. - ->[!CAUTION] -> 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 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`. @@ -44,8 +46,9 @@ Inside this folder you will find: * `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 ->[!NOTE] -> Classes were introduced during the 2024 refactoring of the toolkit! This new architecture enhances robustness, automation, and includes auto-generated documentation for classes. +<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> + # Projects -- GitLab