diff --git a/README.md b/README.md new file mode 100644 index 0000000..339b7fa --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Android Joystick App + +### Summary +This project is a remote control joystick that connect "FlightGear" simulator and fly the plane remotely.
+The project implemented using MVVM architecture and written with kotlin.
+ +### 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