About peekabot
==============

peekabot is a versatile 3D visualization and control tool targeted at robotics 
researchers and developers. It's multi-platform, general purpose, easily 
extendable, scalable, free as in free speech and does not depend on any other 
robotics frameworks to function.

For more information, visit our website at:

http://www.peekabot.org


License
=======

The source code for the peekabot client library is licensed under the 
Boost Software License version 1.0, please see the file LICENSE_1_0.txt for
details.

All source code that is not part of the peekabot client library, including the 
peekabot server, related utilities and all test cases, are licensed exclusively 
under the GNU General Public License version 3 or, at your option, any later 
version. Please see the file gpl-3.0.txt for details.

Data files, such as examples and model files, distributed with peekabot may be 
licensed under different terms, please refer to in-file documentation, 
README.txt, LICENSE.txt or similar in the directory where the file is located.

peekabot includes third party source code, see LICENSE.3rdparty for more 
details.


Installation
============

peekabot is divided into two distinct parts: the server and the client API, 
also referred to as the proxy. Both are built by default but you can disable 
building of either of them by configuring with --disable-server or 
--disable-proxy.

Before starting the installation, make sure your system has all the 
dependencies listed below installed:

 * Boost 1.39 or later
    o Boost.Thread
    o Boost.DateTime
    o Boost.ProgramOptions*
    o Boost.Filesystem*
    o (Boost.Test**)
 * Xerces-C++ 2.7.0* or later
 * gtkmm*
 * gtkglextmm*
 * OpenGL and GLU development files*
 * FreeType*

    * Not required when building only the client API. 
    ** Only needed if building the unit tests (disabled by default).

All set and ready to continue? Good.

peekabot leverages GNU Autoconf and friends for building - if you've ever used 
open source software on a unix you're probably already familiar with them. 
The usual ./configure, make, make install-ritual usually does the trick:

  $ tar xvzpf peekabot-0.X.tar.gz 
  $ cd peekabot-0.X
  $ ./configure
  $ make
  # make install

If everything went according to plan, you should be able to start the peekabot 
server by typing peekabot in your terminal.

Note:
    You can disable the server from being built by configuring with 
    --disable-server. Likewise, you can build the included examples by using 
    the --enable-examples flag.

    If configuring fails, ./configure --help lists options that you might be 
    able to use to solve your problem.


Documentation
=============

Documentation is available at our website at http://www.peekabot.org.
Alternatively, if you have Doxygen installed, you can build it locally by 
running doxygen in the packages top folder:

  $ doxygen

The resulting HTML formatted documentation is available in the doc/doxygen/html 
directory.
