diff --git a/docs/developer/build-environment/linux.md b/docs/developer/build-environment/linux.md
index 58426a424b27f81d3e7fe0fd56037e30f1211382..9fcb6cc92a1431985b31bcfd8312f349a7cb4776 100644
--- a/docs/developer/build-environment/linux.md
+++ b/docs/developer/build-environment/linux.md
@@ -20,7 +20,7 @@ The tools used are:
## Install Build Tools
Since there are many distributions out there and they all call the package which contains all build tools differently, we can provide just a small set of examples.
-If you distribution is not listed here, make sure you at least install:
+If your distribution is not listed here, make sure to at least install:
- `gcc` + `g++`
- `make`
diff --git a/docs/developer/build-environment/macos.md b/docs/developer/build-environment/macos.md
index c6412368019baa8fc60f5ceb3a917229743a525b..4013be81d44d08394617ba2240c391f07c262c85 100644
--- a/docs/developer/build-environment/macos.md
+++ b/docs/developer/build-environment/macos.md
@@ -8,6 +8,6 @@ date: 2024-03-01
!!! info
We have no documentation (yet) how to setup the build environment for *MacOS*.
- Bit since it is also a *Unix* based system, the standard **GCC** compiler should work as well.
+ But since it is also a *Unix* based system, the standard **GCC** compiler should work as well.
⇒ Feel free to experiment and provide documentation of your findings. :apple: :wink:
diff --git a/docs/developer/build/cpp.md b/docs/developer/build/cpp.md
index 7f4b622b87b06c283e92f192ce77c33c8e9b7960..d267d81161a9d8a77742afd66514e9508aab70d0 100644
--- a/docs/developer/build/cpp.md
+++ b/docs/developer/build/cpp.md
@@ -119,14 +119,14 @@ When this happens, you can tell **CMake** explicitly to refresh this cache by:
cmake --preset x64-linux-release --fresh
```
-Read more about the configuration and additional possible frags you can set [here](../build/general.md).
+Read more about the configuration and additional possible flags you can set [here](../build/general.md).
---
## Build {#build}
### Build specific target
-So to build a specific target you call **CMake** with the following command, where `build` is the created build directory and `the-target` is the name of the module you want to compile:
+So to build a specific target you call **CMake** with the following command, where `build` is the created build directory and `<target>` is the name of the module you want to compile:
=== "Windows"
@@ -155,9 +155,6 @@ So to build a specific target you call **CMake** with the following command, whe
### Build all target
When you want to compile all the modules ^^at once^^, you can just omit the *target* option and call **CMake** with:
-!!! warning
- If you do that, you also have to install the python packages first (see [Python build](../build/python.md)).
-
=== "Windows"
```sh
@@ -175,6 +172,8 @@ When you want to compile all the modules ^^at once^^, you can just omit the *tar
```sh
cmake --build --preset x64-linux-release
```
+!!! warning
+ If you do that, you also have to install the python packages first (see [Python build](../build/python.md)).
### Other notes
#### Clean before re-compiling
@@ -197,7 +196,7 @@ When you want to compile all the modules ^^at once^^, you can just omit the *tar
cmake --build --preset x64-linux-release --target <target> --clean-first
```
-That's all folks. This should compile *UNICADO* just fine. 👌
+That's all folks. This should compile *UNICADO* just fine. 👌
#### Improve Compilation Speed
You can increase the build speed by enabling parallel jobs of the build tool. This is as easy as this:
diff --git a/docs/developer/build/general.md b/docs/developer/build/general.md
index e2a9dfd0bca5a6ea68719b3c021b39988f263fde..ae877bcc1f7ed5c10b8174f6471122bf99861cce 100644
--- a/docs/developer/build/general.md
+++ b/docs/developer/build/general.md
@@ -6,7 +6,7 @@ date: 2024-11-05
---
To understand **UNICADO's code base**, there are some things you need to know:
-1. The code is in both :simple-cplusplus: C++ and :simple-python: Python. This makes the software especially existing for development :fire:.
+1. The code is in both :simple-cplusplus: C++ and :simple-python: Python. This makes the software especially exciting for development :fire:.
2. We work a lot with executables in order to integrate them into the workflow (you might have seen this the [standalone download](../../download/takeoff.md)).
@@ -18,9 +18,9 @@ For more information about this system, please refer to its [Documentation :octi
In UNICADO, CMake plays a crucial role as our build system generator. CMake simplifies the process of generating platform-specific build files, making it easier to compile the code across various operating systems. This is especially useful for developers, as it ensures consistency and efficiency in building executables regardless of the environment.
-By defining build instructions in `CMakeLists.txt` files, CMake enables flexible configuration options, allowing us to manage dependencies and set up customized builds effortlessly.
+By defining build instructions in `CMakeLists.txt` files, CMake enables flexible configuration options, allowing us to manage dependencies and set up customized builds effortlessly.
-The typical CMake-based workflow includes 2 steps: configure and build. Here are some insights:
+The typical CMake-based workflow includes two steps: configure and build. Here are some insights:
### Configure CMake
Since **CMake** is independent of the used platform, it needs to figure out on which platform you are running your current build. This process is called *Configuration*. During configuration, **CMake** checks on which platform you are and selects the appropriate build system/compiler.
@@ -52,7 +52,7 @@ These project options are currently available during configuration time:
|**BUILD_SHARED_LIBS**| `OFF` | Decide whether the libraries are built as static or shared libraries.|
|**PACKAGE_SYSTEM_LIBRARIES**| `OFF` | Whether to include all system libraries when creating release packages. *(Only available in `rUNICADO`)* |
|**FIND_LIBRARIES_AS_PACKAGE**| `OFF` |If *true* the libraries are included with `find_package()`, otherwise the *submodule* with `add_subdirectory()` is used.|
-|**STATIC_GLIBS**| `OFF` | Whether to link the *GCC runtime libraries* as static libraries. :warning: ^^**Experimental**^^ |
+|**STATIC_GLIBS**| `OFF` | Whether to link the *GCC runtime libraries* as static libraries. :warning: ^^**Experimental**^^ |
The other options shown in the GUI are specific to **CMake**.
(*Not all options shown in the table are part of the screenshot, since the screenshot was taken before these options were introduced.*)
diff --git a/docs/developer/developer-installation.md b/docs/developer/developer-installation.md
index 70d37c00171f7c4f552cb61639606b9d0fe6fb4d..42066bb4cc92f2eaaefab28f5d6a2bc414d33006 100644
--- a/docs/developer/developer-installation.md
+++ b/docs/developer/developer-installation.md
@@ -4,7 +4,7 @@ These steps to get you up and running are *(Choose according to your operating s
- Make sure your build system is working as explained in the [:octicons-checklist-16: developer prerequisites](../developer/build-environment/windows.md).
- Ensure you have [:octicons-repo-clone-16: cloned all repositories](../developer/get-source-code.md)
-- Follow the [:simple-cmake: build instructions](../developer/build/general.md) to build the tools. Also check out the [:material-library: libaries](../developer/including-libraries.md) and the [CMake Preset](../developer/cmake-presets.md) explanation.
+- Follow the [:simple-cmake: build instructions](../developer/build/general.md) to build the tools. Also check out the [:material-library: libraries](../developer/including-libraries.md) and the [CMake Preset](../developer/cmake-presets.md) explanation.
- Make yourself acquainted with the [style guides](../developer/style/cpp.md).
- Read about the [module structures](../developer/style/cpp-modularization.md) to learn about the strategy patterns.
- Learn about the [:material-test-tube-empty: testing procedures](../developer/testing.md).
diff --git a/docs/developer/review-merge-request.md b/docs/developer/review-merge-request.md
index 5e0cc096edf0541c9c8e29d2ea93d745b9a3c943..a5fe998bee0be7b6d9c83dff4e04492108dbb37c 100644
--- a/docs/developer/review-merge-request.md
+++ b/docs/developer/review-merge-request.md
@@ -13,7 +13,7 @@ Your colleagues have improved the code and would like you to check it? Nice 😎
If you are GitLab beginner, this is our suggested workflow for a review:
-1. Read the [official GitLab documentation](https://docs.gitlab.com/ee/tutorials/reviews/). It includes a ver recommended tutorial :fire: and gives some general inside what is important in an review (checking related issues, examine each file in depth etc.).
+1. Read the [official GitLab documentation](https://docs.gitlab.com/ee/tutorials/reviews/). It includes a very recommended tutorial :fire: and gives some general inside what is important in an review (checking related issues, examine each file in depth etc.).
2. Check the testing pipelines. If tests fail, you and the developer need to decide what to do. The pipelines are also explained in detail in the [testing documentation](testing.md).
3. Make suggestions for improvement. The recommended and easiest :point_up: way is to open the secondary menu of the merge request, select **Changes** and add a comment to a specific line. A :cool: feature is the **Insert suggestion** - this enables the developer to directly include the change in the web interface!
diff --git a/docs/download/getting-started.md b/docs/download/getting-started.md
index 7ffdb4c3c315477b42e4590dddf6ea6c662ce8b9..83b49919a602bb1ed211b66018586160fe4549e7 100644
--- a/docs/download/getting-started.md
+++ b/docs/download/getting-started.md
@@ -1,6 +1,6 @@
-You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then checkout the [Installation Guide](installation.md) and the [Cleared for Take-Off](takeoff.md). It includes the prerequisites, troubleshooting hints and a standalone installer.
+You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then check out the [Installation Guide](installation.md) and the [Cleared for Take-Off](takeoff.md). It includes the prerequisites, troubleshooting hints and a standalone installer.
-If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../developer/developer-installation.md). However, you also need to checkout the [Installation Requirements](installation.md) first!
+If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../developer/developer-installation.md). However, you also need to check out the [Installation Requirements](installation.md) first!
diff --git a/docs/download/installation.md b/docs/download/installation.md
index 29783a2e7f2c673989d012982fa4763e6f015547..e87a1e7aecfbbba7b689b00e243808cc950e30dd 100644
--- a/docs/download/installation.md
+++ b/docs/download/installation.md
@@ -31,6 +31,6 @@
Your installation aborts and the window closes suddenly
- Create the `C:\Programs` folder by yourself.
-- If your installation aborts a good first guess is always to restart your pc (Because temp folders might be cleaned after a restart)
-- If the restart does not help, close your installation window (if still opened) go to `C:\Users\<YourUserName>\AppData\Local\Temp` and delete all folders beginning with *_M*. Afterwards execute the installer again.
+- If your installation aborts a good first guess is always to restart your pc (because temp folders might be cleaned after a restart)
+- If the restart does not help, close your installation window (if still opened), go to `C:\Users\<YourUserName>\AppData\Local\Temp` and delete all folders beginning with *_M*. Afterwards execute the installer again.
diff --git a/docs/index.md b/docs/index.md
index f5580cc3b150c8e501fa8942f4a8a10ca20414f1..fad3ff0fef1398b1d09da8a3bd09ac36a11851f2 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -16,7 +16,7 @@ hide:
# Think. Design. Change.
<div class="intro-text" markdown="1">
-**UNICADO** is a conceptual aircraft design environment. It provides a _robust framework_ for designing, analyzing, and optimizing aircraft based on a minimum set of requirements. Developed in collaboration with _leading German aerospace universities_, it enables designers to define and size an aircraft's geometry, analyse performance and feasibility while balancing aerodynamic, operational, and user-specific requirements Its _modular architecture_ allows for easy customization and adaptability, enabling users to integrate new tools or methods.
+**UNICADO** is a conceptual aircraft design environment. It provides a _robust framework_ for designing, analyzing and optimizing aircraft based on a minimum set of requirements. Developed in collaboration with _leading German aerospace universities_, it enables designers to define and size an aircraft's geometry, analyse performance and feasibility while balancing aerodynamic, operational and user-specific requirements. Its _modular architecture_ allows for easy customization and adaptability, enabling users to integrate new tools or methods.
</div>
<div class="download-button-container">
<a href="download/getting-started" class="download-button">Download UNICADO</a>
@@ -49,7 +49,7 @@ Design your first aircraft.
---
-Get an overview of the tools and libaries.
+Get an overview of the tools and libraries.
[:octicons-arrow-right-24: Documentation](documentation/overview.md)
</div>
@@ -69,7 +69,7 @@ Get insights on how to contribute and develop.
---
-Read about how is behind it.
+Read about who is behind it.
[:octicons-arrow-right-24: About](about.md)
</div>