From edc179baec387583788560cf8085390452975d9d Mon Sep 17 00:00:00 2001 From: Sven Czarnian Date: Sun, 8 Aug 2021 20:47:57 +0200 Subject: [PATCH] add documentation --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34d0121..923aa50 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# aman-com +# 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 defines all related communication files that can be used by the frontend and backend. + +# 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)