README

 # Written by Manfred Thaller <manfred.thaller@uni-koeln.de> 2007 - 2008
 #
 # Copyright (C)  2007 - 2008 Manfred Thaller
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2 of the License, or
 # (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.




The source code contained within this directory expects to be compiled with
Qt support. (Qt is a C++ library and development environment available free of charge from http://www.trolltech.com)

This version has been compiled with version 4.3.1 of Qt


## Added by Michael Carden <mike.carden@gmail.com> 2 March 2009 ##

On Ubuntu, make sure that the qt4 libraries are installed:

sudo apt-get install qt4-dev-tools


Then, in the shotGunSource directory:

qmake-qt4 -project
qmake-qt4
make

Which should result in a shotgun binary that can be run by:

./shotgun

Before using shotgun, create a directory called clean and a directory called dirty adjacent to the shotgun executable. Files to be used as test subjects should be copied to the 'clean' directory and the corrupted output of shotgun will be stored in the 'dirty' directory.

More information may be found in the ReadMeODT.odt file.