============================
*** RoboTour Readme File ***
============================

0. Important Information
========================

RoboTour comes in two different versions. This document describes the 
open-source version also called "RoboTour Lite", which is Free Software,
but unfortunately cannot contain RBI support nor the RobServ@Home client. 
You may want to check the RoboCom homepage if a binary version of
RoboTour is available for your system. 
   
RoboTour is Copyright (C) 2000-2005 Florian Fischer and Martin Trautmann.
See the License (COPYING) for details. 
Please note especially that the software is provided without any warranty. 
We are not liable for any damage caused by the use of the software.

Lots of information is available in the RoboTour HTML help (which should
be available in the help/ subfolder) and on the RoboCom homepage at 
http://www.cyty.com/robocom/.


1. Installation 
===============

Please see INSTALL, in the same folder. For impatient people: usually
     ./configure
     make
     make install
should be enough. 


2. Basic Usage (command-line version)
====================================

You can simply start RoboTour with some robot files (.ROB files) 
as command line arguments.

      Example: robotour ruhe.rob dj.rob test.rob

The result is a tournament of all robots specified against all. At 
the end of the tournament, a table will be shown containing the results 
of all robots.

Wildcards (*) are permitted, for example, to select all files of one type.

      Example: robotour -s thebestbot.rob bots/*.rob top20/*.rob

As the -s parameter is used in this example, only the first specified 
robot, thebestbot.rob, will be simulated against all other robots.

You can get more information about possible options by calling 
      robotour -help
or by reading the file help/cmdline.html. 


3. Basic Usage (graphical version)
==================================

The visualization mode is started only when the command line option -vis, 
or no command line options at all are given.

The RoboTour visualization window contains the following important parts:

    * The toolbar, with buttons to start, stop, pause or abort simulations, 
      and select the visualization mode.
    * The information panel (on the left side), which shows information 
      about the tournament status and the participating programs. 
      It also contains the history of the current simulation. 
    * The message window (at the bottom), which displays robot (and other) 
      error messages.
    * And the most important is of course the field display (on the right), 
      which displays the current simulation. 
    * Additional dialogs are used for setting up tournaments and debugging 
      robots.  

All of these components are be described in more detail in the file 
help/vis.html.


4. Authors and Contact
======================

RoboTour was created by:
	Martin Trautmann (version 1.x)
	Florian Fischer (version 3.x)
	
Many thanks go to:
	Dennis Bemmann (RoboCom inventor)

Please visit:
	http://www.cyty.com/robocom/


