nV@derz! (nvaderz)
(c) 2006-2013 Eric Pellegrin

=============================================================
Installing a binary executable
=============================================================
As of this writing, most released binary executables are meant to
be run from the command line. For example, on Unix-like systems:
	./nvaderz

from within the directory where the nvaderz executable resides.

Currently sounds are not included in CVS checkouts of the source code,
and not usually with bundled source code packages, so if the sounds are
not present in your Resources/Audio directory, you can download a
ResourcePack from the nvaderz SourceForge project page. You can simply
delete or rename your existing Resources folder and replace it with the
one from the Resource Pack. It is probably best to use the most recent
ResourcePack release.


=============================================================
=============================================================
Compiling nV@derz! from source code:
=============================================================
Before compiling this game, you'll need to make sure you have
the allegro game library installed on your system.
    http://alleg.sourceforge.net/

If you want or have to build the Allegro library from source code
for your system, follow the build instructions for your system
in the docs/build directory within the main allegro directory. If
you are on a Unix-like system, after building Allegro you may need
to run
	sudo ldconfig
or
	su -c ldconfig
to make sure your operating system is aware of the new Allegro library.

The game is currently being developed with Allegro version 4.2.2,
and it is not recommended to use a version older than 4.2. There
are a few functions used that replace older, deprecated functions.

*** NOTE: You'll need to make sure the ALLEGRO_BUILD_SCRIPT variable in
source/Makefile points to where you have allegro-config installed.
On my system it is at /usr/local/bin/allegro-config, so my Makefile would read:
	ALLEGRO_BUILD_SCRIPT = `/usr/local/bin/allegro-config --libs`

If your allegro-config were in /usr/bin, change the makefile to:
	ALLEGRO_BUILD_SCRIPT = `/usr/bin/allegro-config --libs`

(By the way ` is a backtick not a single quote.)
***

UNIX-based systems:
To install, run make from the source directory.

  cd source
  make

A game directory will be created in
	__bin/nvaderz_Directory

at the same level as the source directory.

Copy or move that directory to where you would like to keep it.
To remove all object and build files, and their directories, use:

  make clean


Windows systems:
The build system is currently designed to work on UNIX systems (the
game is being developed on Linux), so you can either modify the
Makefile in the source directory, if you know how, or compile the
sources directly.

Unless you're an allegro guru, you'll probably need to use the
allegro-config script that was installed with the allegro library.
I'm not familiar with Windows console commands, but here's how it
would look on my system, and you can modify it to make it work
for you:

  (from the source directory)
  cc *.c -o nvaderz `/usr/local/bin/allegro-config --libs`

cc is the c compiler
/usr/local/bin/ is the path to the config script on my system
` ... ` (those are backticks, not apostrophes) is the notation for
running a console command and having its output literally
substituted into the current command

Any Windows developers who have suggestions for modifying the Makefile
or providing other installation instructions for Windows users can
contact me at pellea72(at)yahoo(dot)com. (Replace (at) with @ and
(dot) with .)
