Create README.md

Added by Avraham
This commit is contained in:
Avraham Bar Ilan 2021-06-26 23:38:56 +03:00 committed by GitHub
parent 6f5cb3186c
commit f694d2b892
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# Android Joystick App
### Summary
This project is a remote control joystick that connect "FlightGear" simulator and fly the plane remotely.<br/>
The project implemented using MVVM architecture and written with kotlin.<br/>
### Setup
Before running the app you should do the following steps:
* Clone this repositories.
* Install Android Studio.
* Install Flight Gear Simulator (it is an open source project).
* Inside FlightGear go to Setting -> Additional Settings and write:
``--telnet=socket,in,10,127.0.0.1,6400,tcp``.
* Press Fly and hit the Autostart button.
### Run
* Run the App in your favourite IDE
* Put your computer IP in the field and put ``6400`` in port field.
* press Connect and hit the Throttle up :airplane:.
* Enjoy your flight.
### UML
#### todo
### Demo presentation
#### todo