Read Me

# README
# Copyright Ian Finlayson
# This code is released under the MIT license
# see the file COPYING for details

* Building
  To compile the game, you will need to have the following installed:
    - scons
    - SDL-devel
    - SDL_image-devel
    - SDL_mixer-devel
    - SDL_ttf-devel
    - lua-devel
    - gcc-c++

  To compile the documentations, you will need
    - texlive-latex

  These are all package names for Fedora Linux, but these are all available
  on other systems as well.  Consult your package manager.

  When you have the prerequisites installed, simply run "make" in the top
  level directory.  This should produce an executable.
  
  This project uses scons to build the actual software, because it is much
  better suited for building software than make is, but uses make to run
  general shell commands, since it is better at that task than scons.


* Installation
  For now the game can't be easily installed into the file system.  The
  executable must be run from the same directory as the "res" folder.
  In the future, the installation will be supported and automated.


* Directories
  - src: holds all source code for the game
  - docs: holds LaTeX source for the users manual and also
      generated pdfs once they are compiled
  - bin: holds compiled object files
  - res: holds resource files for the game:
    - fonts: true type fonts used
    - images: png images used
    - music: tuxguitar tab files used to generate accompanying ogg files
    - sounds: wav sound files used


* Bugs & Questions
  Any bugs, questions or feedback, can be sent to finlaysoni@gmail.com