savadha2 · hayaalsh · Aug 21, 2018 · Aug 21, 2018
diff --git a/README.md b/README.md
@@ -1,21 +1,26 @@
 # PyUAVSim
 Light weight Python simulator for small UAVs
 
-
-Completed Feature List:
+## Completed Feature List:
 1. Autopilot for fixed wing
 2. Sensors (GPS, IMU) with error models
 3. Path following and Path manager implemented
 4. Changed interfaces so that Users can write apps with the base classes provided
 
 The simulator is near complete with all the necessary bare minimum functional implementation. It should be straightforward to extend its functionality. Feel free to email me (av.sarath@gmail.com) if you have any questions
 
-Extensions:
 
+## How to run:
+1) Navigate to PyUAVSim directory
+2) If you are using conda environments, activate the one with python 2.7. In my case, that is `source activate py27`
+2) Install requirements using `pip install -r requirements.txt`
+3) Run a sample code provided with the simulator`python -m examples.trim_and_autopilot`
+
+## Extensions:
 1. State estimation using kalman filter/variants
 2. Pathplanner class with RRT 
 3. Wind models is not there due to their slightly complex nature - this will be added at the very end
 4. support for quadrotos
 
-
-Reference: Small Unmanned Arcraft - Theory and Practice by Randal W. Beard and Timothy W. McLain
+## Reference: 
+Small Unmanned Arcraft - Theory and Practice by Randal W. Beard and Timothy W. McLain
diff --git a/apps/__init__.pyc b/apps/__init__.pyc
diff --git a/apps/__pycache__/__init__.cpython-36.pyc b/apps/__pycache__/__init__.cpython-36.pyc
diff --git a/apps/__pycache__/fixedwing_uav_autopilot.cpython-36.pyc b/apps/__pycache__/fixedwing_uav_autopilot.cpython-36.pyc
diff --git a/apps/fixedwing_uav_autopilot.pyc b/apps/fixedwing_uav_autopilot.pyc
diff --git a/apps/fixedwing_uav_trim.pyc b/apps/fixedwing_uav_trim.pyc
diff --git a/controllers/__init__.pyc b/controllers/__init__.pyc
diff --git a/controllers/pid.pyc b/controllers/pid.pyc
diff --git a/examples/__init__.pyc b/examples/__init__.pyc
diff --git a/examples/__pycache__/__init__.cpython-36.pyc b/examples/__pycache__/__init__.cpython-36.pyc
diff --git a/examples/__pycache__/trim_and_autopilot.cpython-36.pyc b/examples/__pycache__/trim_and_autopilot.cpython-36.pyc
diff --git a/examples/trim_and_autopilot.py b/examples/trim_and_autopilot.py
@@ -141,7 +141,7 @@ def main():
     ax.set_zlim3d(0, 100)
 
     initial_state = [0, 0, 0, 0.0, 0., 0.0, 0, 0, 0, 0, 0, 0]
-    tester = Tester(initial_state, 0, '../configs/aerosonde.yaml', ax, T_sim=15.0, dt = 1.0/200.0)
+    tester = Tester(initial_state, 0, 'configs/aerosonde.yaml', ax, T_sim=15.0, dt = 1.0/200.0)
     tester.test_autopilot(72.0, 0, 500, animate = True)
     #tester.test_trim(35.0, 0.025, 100, 15000, animate = True)
     tester.plot()

diff --git a/examples/trim_and_autopilot.pyc b/examples/trim_and_autopilot.pyc
diff --git a/uav/__init__.pyc b/uav/__init__.pyc
diff --git a/uav/__pycache__/__init__.cpython-36.pyc b/uav/__pycache__/__init__.cpython-36.pyc
diff --git a/uav/__pycache__/fixed_wing.cpython-36.pyc b/uav/__pycache__/fixed_wing.cpython-36.pyc
diff --git a/uav/autopilot.pyc b/uav/autopilot.pyc
diff --git a/uav/dynamics.pyc b/uav/dynamics.pyc
diff --git a/uav/fixed_wing.pyc b/uav/fixed_wing.pyc
diff --git a/viewer/__init__.pyc b/viewer/__init__.pyc
diff --git a/viewer/viewer.pyc b/viewer/viewer.pyc