******************************************************************************
File Name : README.TXT
Date      : 27th October 2005
Author    : Richard Woolcock
******************************************************************************

This is my entry for the MudMagic Code Challenge.  The challenge consists of 
a series of library functions which can be used as the basis for creating card 
games within a mud, utilising a standard 52 card deck.

I use C++ for my current mud development (God Wars II), but as most muds are 
written in C, I decided that it would make more sense to use that.  However 
the code can also be compiled cleanly as C++.

The main directory structure for this snippet is laid out as follows:

1. contest/doc

This directory contains installation.txt (which describes how to install the 
snippet into Merc 2.1), licence.txt (containing the licensing conditions) and 
requirements.txt (which lists each of the challenge requirements alongside its 
corresponding function within the snippet).

2. contest/Merc21

This directory contains a copy of Merc 2.1, with the snippet installed as 
described in the installation.txt file.

3. contest/standalone

This directory contains just the snippet itself, along with a makefile and a 
test.c file.  You can use this to test the snippet functions as a standalone 
program - just update test.c to call the functions you wish to test.