From fbd0b513a4c952eeac75ea884b11bcb0e0c02923 Mon Sep 17 00:00:00 2001
From: Sebastian Oberschwendtner <sebastian.oberschwendtner@tum.de>
Date: Fri, 8 Sep 2023 11:24:34 +0200
Subject: [PATCH] Actually adds the markdown content for module overview by
 adjusting the .gitignore accordingly.

---
 .gitignore                          |   2 +-
 docs/modules/additional-software.md |  39 +++++++++
 docs/modules/analysis.md            |  56 ++++++++++++
 docs/modules/libraries.md           | 129 ++++++++++++++++++++++++++++
 docs/modules/overview.md            |  17 ++++
 docs/modules/sizing.md              |  96 +++++++++++++++++++++
 6 files changed, 338 insertions(+), 1 deletion(-)
 create mode 100644 docs/modules/additional-software.md
 create mode 100644 docs/modules/analysis.md
 create mode 100644 docs/modules/libraries.md
 create mode 100644 docs/modules/overview.md
 create mode 100644 docs/modules/sizing.md

diff --git a/.gitignore b/.gitignore
index 7813adc..3828992 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
 # Ignore generated Doxygen docs in modules folder
-/docs/modules/
+/docs/modules/**/
diff --git a/docs/modules/additional-software.md b/docs/modules/additional-software.md
new file mode 100644
index 0000000..09d7e0a
--- /dev/null
+++ b/docs/modules/additional-software.md
@@ -0,0 +1,39 @@
+---
+title: Additional Software
+summary: Overview of the additionalSoftware repository
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-08
+glightbox: false
+---
+## cpacsInterface
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## designEvaluator
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## reportGenerator
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## testFramework
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
diff --git a/docs/modules/analysis.md b/docs/modules/analysis.md
new file mode 100644
index 0000000..e7cf742
--- /dev/null
+++ b/docs/modules/analysis.md
@@ -0,0 +1,56 @@
+---
+title: Analysis
+summary: Overview of the analysis modules of aircraftDesign repository
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-08
+glightbox: false
+---
+
+## calculateEmissions
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## calculatePerformance
+![Icon](../assets/images/icon.png){width=200  align=left}
+The module `calculatePerformance` is used to evaluate the mission performance of the design.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()|
+
+## calculatePolar
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## costEstimation
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
+
+## massEstimation
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## missionAnalysis
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
\ No newline at end of file
diff --git a/docs/modules/libraries.md b/docs/modules/libraries.md
new file mode 100644
index 0000000..2d0a3ab
--- /dev/null
+++ b/docs/modules/libraries.md
@@ -0,0 +1,129 @@
+---
+title: Libraries
+summary: Overview of the libraries respository
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-08
+glightbox: false
+---
+
+## aerodynamics
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## aircraftGeometry
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.0.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## aircraftGeometry2
+![Icon](../assets/images/icon.png){width=200  align=left}
+This library is based on the older [aircraftGeometry](#aircraftgeometry) library and extends it to be more modular.
+The modularity and flexibility is achieved by using the high performance [Computational Geometry Algorithms Library](https://www.cgal.org/) also known as **CGAL**.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](aircraftGeometry2/index.html)|
+
+## aircraftNetwork
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## aixml
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## atmosphere
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## engine
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## liftingLineInterface
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## moduleBasics
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## propulsionsystem
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## runtimeInfo
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## spline
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## standardFiles
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## svgPlot
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## unitConversion
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
\ No newline at end of file
diff --git a/docs/modules/overview.md b/docs/modules/overview.md
new file mode 100644
index 0000000..1acc339
--- /dev/null
+++ b/docs/modules/overview.md
@@ -0,0 +1,17 @@
+---
+title: Overview
+summary: Overview of the software groups.
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-08
+glightbox: false
+---
+
+UNICADO collects the following software modules.
+The modules are grouped into:
+
+- **Aircraft Design**:
+    - [Sizing Tools](sizing.md)
+    - [Analysis Tools](analysis.md)
+- [ Libraries ](libraries.md)
+- [Additional Software](additional-software.md)
\ No newline at end of file
diff --git a/docs/modules/sizing.md b/docs/modules/sizing.md
new file mode 100644
index 0000000..e49f024
--- /dev/null
+++ b/docs/modules/sizing.md
@@ -0,0 +1,96 @@
+---
+title: Sizing
+summary: Overview of the sizing modules of aircraftDesign repository
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-08
+glightbox: false
+---
+
+## createMissionXML
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## createMissionXML
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## empennageSizing
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## engineSizing
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## fuselageDesign
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## hydrogenTank
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
+
+## initialSizing
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## landingGearDesign
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## propulsionIntegration
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## systemsDesign
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+## wingDesign
+![Icon](../assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
\ No newline at end of file
-- 
GitLab