/***************************************************************************
 *   This file is part of the 'Shout LVCS Recognition toolkit'.            *
 ***************************************************************************
 *   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 by Marijn Huijbregts *
 *                                                                         *
 *   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.        *
 *                                                                         *
 *   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.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

***************** DIRECTORY STRUCTURE **************************************

This release contains the following directories:
* html             : contains documentation (html/index.html)
* src              : contains the source files

***************** BUILD INSTRUCTIONS ***************************************

I use the great application "kdevelop" to edit and build my source code, but if
you want to build the source code manually, this is how kdevelop does it:

Start in the main shout directory and type:
------------------------------------------
gmake -f Makefile.cvs
mkdir release
cd release
CXXFLAGS="-O3 -funroll-loops -march=pentium4 -malign-double -mfpmath=sse -msse -msse2" ../configure
gmake -j1

Or you can execute the ./configure-make.sh script in the main directory.

***************** DOCUMENTATION ********************************************

You can find the documentation in the HTML directory. For any questions that the documentation
does not answer please email me at: marijn.huijbregts@gmail.com