=======================
===== SMLabyrinth =====

 ***** Pietris.net MINIMAL VERSION *****
 ***** No DEBUG tags in Makefile ! *****

 A simple game of labyrinth.

 Authors: <private>, MrC. 
  (See CREDITS file for more informations) 

 Built for: 
    <private>
    (Web link: http://www.pietris.net)

 Copyright 2009 © MrC.

=================
== Description ==

 The goal of the game is to reach the nearest door from the start point in all 
 the different levels, in order to gain an higher score.
 Every schema, in which the difficult increase compared to the increasing of 
 the number of the level, contain an unique start point and more doors.
 The player, to gain the highest score, has to reach with the minimum possible
 number of steps and in the minimum time, the nearest door. Once a schema is
 finished, it will be shown the gained score and then another schema will be
 reach until the completion of the all (10) levels. At the end of the game it
 will be possible to save the achieved record, in order to keep a record chart,
 displayable using the Options menu.
 The player can starts a new game using the entry "New game" from the File 
 menu, or open a single schema using the entry "Open game".


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

The documentation is included into the program package. It can be find
under the directory doc/ and the index is doc/html/index.php 

User can also generate the same documentation using command 'make doc'.
To generate the schema graphs, Doxygen may needs the package 'graphviz'.


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

(see INSTALL file for more informations)


=================
== Portability ==

This program was tested only on GNU/Linux Operating System, 
in details:

  - Debian 6, 7, 8
  - Ubuntu 8.10, 9.04 (*), 10.04, 12.04, 14.04
  - Kubuntu 8.10, 9.04
  - RedHat 9.0a
  - DSL (Knoppix) 3.3.9

(*) Raccomanded.

This program depends by some library and some tools,
that may be different from each OS.

libgtk+2.0-dev libglib2.0-dev
glade-3 libglade2-0, libglade2-dev gcc

Eg. (Kubuntu 9.04):
 gcc version 4.3.3 (Ubuntu 4.3.3-5ubuntu4)
 glade-3 libgtk2.0-dev libglib2.0-dev


===================================
== Program files and directories ==

SMLabyrinth_9.10.26/    Main level; Makefile, other files and subdirectories.
  |_
  | doc/                Documentation.
  |  |_
  |    html/            Html documentation file.
  |_
  | src/                Source code.
  |  |_
  |    games/           All predefinite games.
  |      |_
  |      | level x/     Games of level x 
  |      |              (where x is a number greater or equal to 0)
  |      ...
  |      |_
  |        level y/     Games of level level y 
  |                     (where y is a number greater or equal to x)
  |_
  | exe/                Executable, object and game record files.
  |  |_
  |    games/           Copy of all predefinite games.
  |      |_
  |      | level x/     Copy of games of level x 
  |      |              (where x is a number greater or equal to 0)
  |      ...
  |      |_
  |        level y/     Copy of games of level level y 
  |                     (where y is a number greater or equal to x)
  |_
  | img/                Images and icons.
  |_
    testing/            All testing files.


(See MANIFEST file for the list of file)

=============
== License ==

This program is free software:
  you can redistribute it and/or modify it
  not until you have contacted and received an authorization
  replies from the authors and under the terms of the GNU
  General Public License as published by
  the Free Software Foundation, either version 3 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, see <http://www.gnu.org/licenses/>.

(See COPYING for more informations about GNU GPL)

(The same informations are visible in the Graphic User Interface
under the 'about' menu and/or in the program usage)


===============
== Changelog ==

Version number is composed by YEAR.MONTH.DAY
Eg. 9.9.28 means 28 September 2009.

- 9.10.26 Third release.
    - Update documentation
    - Optimize the code

- 9.10.8 Second stable release.
    - Update documentation
    - Change the directory structure
    - Update the Makefile
    - Add the possibility to set the verbosity
      tracing level by command line
    - Add more control on defines

- 9.9.28 First stable release.


===========
== Notes ==

This first version doesn't include any FAQ*, NEWS** or HISTORY*** file.

  *   == Frequently Asked Questions ==
  **  == News ==
  *** == History ==
  
