****************************************************************************************************
*****    This is a part of KardsGT.                                                            *****
*****                                                                                          *****
*****    Copyright (C) 2008  John Schneiderman <JohnMS@member.fsf.org>                         *****
*****                                                                                          *****
*****    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 3 of the License, or (at your option) any later version.               *****
*****                                                                                          *****
*****    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/>.                                  *****
****************************************************************************************************

                              DESCRIPTION
KardsGT is a card game suite. Each of our computer players have their own way of playing each game.
The project is currently at a beta level of development, but is still playable. There are currently
some known bugs, please see the TODO list on our website for more information on them.
Main website: http://kardsgt.nongnu.org
Development website: http://savannah.nongnu.org/projects/kardsgt

                              BUILD ENVIRONMENT
KardsGT is mainly developed on Mandriva 2008 Spring using just the standard development libraries,
KDE, and QT 4. It is also tested on Debian 4.0. At the time of this writing, Debian stable is
unable to compile as it only has QT 4.2.

                              DIRECTORY MAP
All the source code is listed in the src directory. Inside the src directory as well are the images
and the user documentation files. All the game images are found in the images directory or in the
case of the individual player under the players directory in each of the player's directory.
The user documentation is all found in the doc directory. Installation instructions can be found in
the INSTALL file. For a listing of all the contributors to KardsGT you can find that information in
the CREDITS file. All the current news can be be found on our development website.

                              INSTRUCTIONS
Once compiled you can run the programme by typing: kardsgt or kardsgt-debug depending on build.
You can begin any game from the game menu by selecting the game you want to play. Information
on how to play each game as well as information about our players can be found in our in-game
documentation located under the help menu.
