diff --git a/README.md b/README.md index 1a2faf4dddaa6437cc30162d25dcecef9a040b75..efd59d943ad85fb1df025c329bc18f3dda735992 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -Skyward Hub \ No newline at end of file +## Skyward Hub + +The purpose of this document is to provide an easy access to the software documentation for a deep understanding of the developed system. + +### Wiki + +The [Skyward Hub wiki](https://git.skywarder.eu/scs/skywardhub/-/wikis/SkywardHub-Wiki) contains detailed information regarding the purpose of this software, its design, and some useful "how-to" guides for using the software and contribute to its development. + +### Quick Overview + + +- The **SkywardHub** is an HMI (_Human-Machine Interface_) suite. The software is made of _Modules_ that can be arranged in different +_configurations_ each of which is design for a specific purpose. +- The **GroundStation** is one of the possible configurations of the modules, it is used for pre-flight operations, testing, and integration procedures. + +The purpose of the SkywardHub is to offer a standard development framework for quick deployment and testing of new functionalities, ensuring a coherent design among all the HMI applications developed in Skyward. The modular and configurable design aimed to guarantee a flexible UI and maintainable software for long-term compatibility with future mission requirements.