add documentation
This commit is contained in:
27
README.md
27
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)
|
||||
|
||||
Reference in New Issue
Block a user