cvrDownload.h

/*
 * Copyright (C) 1998-2006
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef _CVR_DOWNLOAD
#define _CVR_DOWNLOAD

/**

\page download Downloading the CVR-Lib.

Following sections describe how to download.

\section downcontents Contents

- \ref subversion
- \ref tarballs
- \ref xtrnlibs
- \ref docs

\section subversion Subversion

To get the newest version of the LTI-lib you will need Subversion.  On
GNU/Linux this software is usually already installed.  A version for Windows
can be found <A HREF="http://tortoisesvn.tigris.org/">here</A>.

To check out the whole project for the FIRST time, use the instructions <a
href="http://sourceforge.net/svn/?group_id=208205">here</a>.

\subsection chglogtokens Special commit tokens for Change-Log files

Change-Log files are periodically generated.  They contain \e important
changes that have occurred in a specified amount of time and everyone
should know about them.  The development of the library involves
mostly "normal" changes, like small bug fixes, documentation additions
and corrections, or small not-very-important interface changes, which
are not worth to mention about.  To generate a consistent Change-Log
file for a big library like the CVR-Lib can become tedious and
difficult.  Hence we introduce the use of some special tokens within the
commit log message, that will exclusively identify the logs to be considered for the Change-Log file.

If you make a big change or addition to the library of one of its
files or classes, use one of the following 4 character tokens to
indicate you want the given log included in the next Change-Log file:

- \@ADD new feature, file or class added
- \@DEL feature, file or class removed
- \@MOV file moved to another place or renamed
- \@FIX bug fixed with detailed explanation of the bug itself and the fix.
- \@DEP deprecated feature, file or class method with alternative solution
- \@API change in the Application Programmers' Interface (API)
- \@CHG major change in the functionality, or implementation, that everyone
        must know about it.

\section tarballs Source Tar-Balls

You can get a snapshot of the internal repository.  Please consider
that some errors might exist, and this version could not be compiled.
Please report any errors using the tracker sytem in SourceForge.

Download the sources as bzip2 compressed tar file <a
href="cvrlibsrc.tar.bz2">here</a>.  You can un-tar this file with:
\code
tar xjvf cvrlibsrc.tar.bz2
\endcode

Download the sources as gzip compressed tar file <a
href="cvrlibsrc.tar.gz">here</a>.  You can un-tar this file with:
\code
tar xzvf cvrlibsrc.tar.gz
\endcode

\section xtrnlibs External Libraries

The CVR-Lib requires to show its full power some external libraries.
The visualization classes use some GUI widgets and to keep them
portable a GPL-licenced widget library was chosen: <A
HREF="http://www.gtk.org">GTK+</A>.  For Linux, these libraries are
usually included in all major distributions.  For MS Windows, this can
be a little bit more complicated.

If you are in the <code>techinfo.rwth-aachen.de</code> domain, you can
get a (maybe outdated) package with all required external libraries from
<A HREF="http://tintas.techinfo.rwth-aachen.de/software/xwinlibs.tar.gz">here</A>.

If you can get this last file, unpack it into the folder
<code>cvrlib\\win</code>.  All Perl scripts that build MS Visual C++
project files, assume that you have GTK+ installed in these directories.

You can also use the CVR-Lib installer from
<a href="http://sourceforge.net/projects/cvrlib/">SourceForge</a>, or get
the libraries indicated in \ref vcReq yourself.

\section docs Documentation

The programming style guide can be obtained in
<a href="../styleguide/de/UsersGuide2.ps.gz">German</a> or in
<a href="../styleguide/en/DevelopersGuide.pdf">English</a>.
The English version is updated more frequently.

You can get the most recent HTML documentation API, generated with
Doxygen as <a href="../html/cvrlibdoc.tar.bz2">tar.bz2</a> or <a
href="../html/cvrlibdoc.tar.gz">tar.gz</a>.  The additional index
files required to generate Compressed HTML (*.chm files) can be found within
these files.

*/

#endif