File	Date	Author	Commit
Matlab_shell_trajectories	2013-12-24	Joshua Bough	[79913a] adding the rest of the required shell trajectories
client	2014-02-08	Joseph Warren	[fd3b44] Surf now grows at a rate specified in meters pe...
common	2014-01-29	Joseph Warren	[7fa2f5] Speed of surf now defined by generator
include	2014-01-29	Joseph Warren	[7fa2f5] Speed of surf now defined by generator
server	2014-02-09	Joshua Bough	[cbc1e8] Fixed typo in CMakeLists
.gitignore	2013-06-24	JoshuaBough	[066aca] Added .gitignore file to stop git wanting to tr...
CMakeLists.txt	2014-02-08	Joshua Bough	[1a60c0] Moved simulation and networking code into the s...
COPYRIGHT	2013-08-01	Joseph Warren	[ea49d0] Added Global Copyright information
README.build	2013-12-10	JoshuaBough	[63b288] updated build readme with method for running si...
README.md	2013-08-01	Joseph Warren	[fc12f0] Added Global README
gpl-3.0.txt	2013-08-01	Joseph Warren	[ea49d0] Added Global Copyright information
write_and_build.py	2013-12-31	JoshuaBough	[f82c66] Scripted running of simulation

Read Me

Open Dreadnought should built as an out of source CMake build.

In order to build it the following are required
  An install of CMake
  development libraries for openGL and GLU
  development libraries for SDL and SDL_image
  development libraries for Assimp (the open asset import library)
  development libraries for libxml2

An out of source build means that the files output by the build and the source files are in completely separate folders. This has the advantage that the source folder should exactly mimic what's stored in git.

The following example shows how to build Open Dreadnought, assuming that the source folder is called Open-Dreadnought/. CMake can create several different types of builds, such as Eclipse projects, this example creates Unix Makefiles.

Create a directory to build into, in this example I will use build-open-dreadnought/ and assume that this directory has the same parent folder as Open-Dreadnought/.

Change directory to the build directory;
cd build-open-dreadnought/

From the build directory, run CMake with the source directory as an argument;
cmake ../Open-Dreadnought/

Then run make in the build directory;
make

This should have built Open Dreadnought in the build directory, you can now run;
cd client
./Render_Test config.xml

Or alternatively run;
cd simulation
./Combat_Sim game_config.xml ship_instances.xml

Or similar.