This is a simple roguelike game used to show concepts of C programming language and style for ICT first year students.
This file provides minimal instructions to install and run the game.

Building
--------
This program employs the make system for building.
On Unix-like systems (Linux, possibly Mac), just type "make" at the prompt.
See the "Makefile" file for more info on possible arguments to the make command.
On Windows systems, you're on your own -- and in any case you'll need a POSIX compatibility layer, since I haven't implemented conio.h support.
[Update: there is now a minimal conio.h support, although I haven't really tested it; you need to compile with -DCONIO -- see how the makefile does for ncurses.h, and use a similar command line on your C compiler]

You'll find the main game executable in this folder (game-curses, or game-nocurses if you don't have a console I/O library installed; see Installing ncurses to install the appropriate library).
There are also several smaller tests, which you can find in the "test" folder.
Type "make check" to run the tests (some require interaction: press "s" to end).

Installing ncurses
------------------
In Debian based systems (Ubuntu, for example), type the following to install console I/O support libraries:
	sudo apt-get install ncurses-dev

On Mac OS X, you should install the libncurses5-dev package. This should be possible via the following command (note I don't have a Mac, so this is simply Google-fu):
	sudo fink install libncurses5-dev

Documentation
-------------
This program employs doxygen for documentation. 

Thus, you need to have the packages doxygen and graphviz installed for best results. Once more, on Windows you are mostly on your own -- look up instructions on Google.
On Debian/Ubuntu etc., simply type 
	sudo apt-get install doxygen graphviz

Type "make doc" or "doxygen doxy.conf" to generate the documentation.
You'll find the documentation in the "doc" folder. 
Open "./doc/html/index.html" with your browser.
The "doc/latex" folder contains the files to generate a (large) PDF documentation. Type "cd ./doc/latex", then "make" to generate the documentation file, "refman.pdf".
Note that for the latter, you need to have the tetex package installed.

Running the game
---------------
Once the game is correctly built, type the following at the command prompt:
	./game-curses test_level.txt
You can use other level files, provided you write them ;-)

