From 539987868c0b3e12012ddc9a1e205cfb110eee28 Mon Sep 17 00:00:00 2001 From: Sven Czarnian Date: Mon, 9 Aug 2021 22:05:52 +0200 Subject: [PATCH] update the documentation --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f6f125..e7abdbf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# aman-es +# Arrival MANanager (AMAN) +## System description + +AMAN is splitted up into four different components. +* aman-com defines the diffent message types +* aman-es implements an EuroScope plugin to communicate with [aman-sys](https://git.vatsim-germany.org/nav/aman-sys) +* aman-sys implements the backend system to plan an optimal arrival sequence for the different airports +* aman-web implements a web-interface to configure [aman-sys](https://git.vatsim-germany.org/nav/aman-sys) and visualize sequences + +## Component description + +AMAN uses [Protocol Buffers](https://developers.google.com/protocol-buffers) +for the message serialization and message definition between the EuroScope instance and the AMAN backend. + +Additionally is [ZeroMQ](https://zeromq.org/) used for the communication abstraction layer. + +This component extracts all relevant information out of the VATSIM network and sends the information to the server. +Additionally is a unique identifier used to verify connections to the backend. +According to data protection is the ZeroMQ-based network encryption used. +Every controller needs his own unique identifier. + +# Additional libraries + +* [ZeroMQ](https://github.com/zeromq) - GNU GPLv3 +* [Protocol Buffers](https://github.com/protocolbuffers/protobuf) - BSD-3 + +# License + +AMAN is released under the [GNU General Public License v3](LICENSE)