------------------------------------------------------------------------------------
CS296 PROJECT - GEARED BIKE
------------------------------------------------------------------------------------ 

Contributors:

Rohit Kumar 
Suman Sourabh 
Nitin Chandrol 

------------------------------------------------------------------------------------

Links :

1. Project Webpage :- http://www.cse.iitb.ac.in/~rohit/cs296_g18_project.html

2. HTML profile report generated by python script from LATEX report file :
	http://www.cse.iitb.ac.in/~rohit/g18_prof_report.html

------------------------------------------------------------------------------------
Instructions for executing :

1. "make install" command in the base code folder installs the executable and the 
   documentation in the INSTALL_FOLDER variable defined in the MAKEFILE. It can be 
   set by the user.
   The documentation contains the doxygen documentation, pdf report generated from LATEX
   and html profile report generated from python script.

2. By running the executable, a mountain bike appears on the screen which is controlled
   by these keyboard events:
  
	a) Pressing 'q' continously provides a forward motion to the cycle through pedals.
	b) Pressing 'd' once shifts the gear down by one unit.
	c) Pressing 'i' once shifts the gear up by one unit. (Initially the gear is at highest position)
	d) Pressing 'b' applies front disc brakes and provides an opposite jerk to front wheel.

------------------------------------------------------------------------------------

References:

1. Youtube Box2D video on mountain bike : https://www.youtube.com/watch?v=bBIXpu-D_Zo
2. Box2D manual and doxygen documentation

------------------------------------------------------------------------------------