Task based flock sim
=============================
Author: Ruben Penalva
Website: http://www.rpenalva.com
Email: ruben.penalva@rpenalva.com

Requirements
============
- Windows 7 x64 (Tested only on Windows 7 x64), Windows 7 x86 (untested) or Windows Vista x64/x86 (untested)
- Opengl 2.0 capable 3d card

About
=====
This file shows you how is structured the folder tree, what information you can
get and how to access to this information.

Folder Structure
================
"TaskBasedFlockSim\build\" - binaries compiled with Microsoft Visual Studio 2008 x86
	- "TaskBasedFlockSim" - Test Application
		- "Win32" - x86 build
			- "Debug" - debug compilation
			- "Release" - release compilation
		- "x64" - x64 build
			- "Debug" - debug compilation
			- "Release" - release compilation

"TaskBasedFlockSim\doc" - doxygen documentation

"TaskBasedFlockSim\libs\" - libraries needed for compile and execute the test
	- "glew" - Glew library
	- "freeglut" - headers, static libraries and dynamic libraries of glut32
	- "boost" - Boost library
	- "msvc9" - Visual Studio Runtime DLLs
	- "xr.qt.msvc" - Qt Build Rules for Visual Studio
	
"TaskBasedFlockSim\projects\" - Microsoft Visual Studio Projects
	- "msvc9" - projects for Visual Studio 2008

"TaskBasedFlockSim\src\" - Source 
	- "TaskBasedFlockSim" - source code of the library.

"TaskBasedFlockSim\data\" - Geometry data 
	
Source Code
===========
The test is composed of one application. The source code is located in folder 
"TaskBasedFlockSim\src\TaskBasedFlockSim".

It is written in C++, using Microsoft Visual Studio 2008 as ide. Also, it uses 
Glew, FreeGlut, Boost and Qt.

ThirdParty Libraries
====================
This test uses:
- Freeglut: http://freeglut.sourceforge.net/
- Glew: http://glew.sourceforge.net/
- Opengl: http://www.opengl.org/
- Boost: http://www.boost.org
- Qt: http://qt.nokia.com/products/
- Qt Build Rules for Visual Studio: http://code.google.com/p/xr-qt-msvc/

Documentation
=============
You can find an already compiled doxygen documentation in "docs\api\html\index.html".

Compile
========
In order to build the solution you will need:
- Visual Studio 2008 or better.
- Qt SDK installed and built (depending on what configuration you build you will need 
  to build both x64 and x86 versions of qt). Two environment variables must be defined:
  "QTDIR"(x64 qt path) and "QTDIR_X86"(x86 qt path).
  
The solution file "TaskBasedFlockSim\TaskBasedFlockSim.sln" is located in the root path of the test folder. 
Open it and rebuild all. Once it has been compiled the binaries are placed in "TaskBasedFlockSim\build\".
Note that an already compiled binary is provided in "TaskBasedFlockSim\build\".

Execute
=======
Execute "TaskBasedFlockSim\build\TaskBasedFlockSim\x64\Release\TaskBasedFlockSim.exe"

Tools / Technology
==================
Tools/tech used to develop this tech demo:
- C++
- Qt
- Opengl
- Glew
- Freeglut
- BOOST: smart_ptr, noncopyable, thread, mutex...
- Visual Studio 2008
- Subversion
- Redmine
- Windows 7 x64

