
 __   _ _____  ______ _     _ _______ _______ _     _ _______ ______  _______
 | \  |   |   |  ____ |_____|    |    |______ |_____| |_____| |     \ |______
 |  \_| __|__ |_____| |     |    |    ______| |     | |     | |_____/ |______
                                                                             

                    http://www.nightshadesoftware.org

                   NIGHTSHADE INSTALLATION INSTRUCTIONS

===============================================================================
                           BINARY INSTALLATION
===============================================================================
Most users will prefer using precompiled binary packages:

- WINDOWS USERS :
run the setup.exe and follow the instructions.

- MACOSX USERS (when available, see building from source instructions below):
run nightshade.dmg

- LINUX USERS :
Look for the binary package matching your distribution.


===============================================================================
        COMPILATION from the source package (nightshade-XXX.tgz)
===============================================================================

If you can't find a suited binary package or if you are curious you can also 
compile the software by yourself.

Compilation and installation have been successfuly tested on many plateforms 
and OS (including windows). These are general explanations for any architec-
tures. Special (tricky) cases are described below.

To compile nightshade, you will need the following development libraries :
- openGL (libgl-dev on linux, libopengl32 on win32)
- GLU (libglu-dev on linux libglu32 on win32)
- SDL - www.libsdl.org (libsdl-dev).
- Zlib - www.zlib.net (zlib-dev).
- PNG - www.libpng.org (libpng-dev).
- SDL_Pango : for font rendering
- SDL-mixer : this is optional, but required to enable sound support (libsdl-mixer-dev)

Once this is installed you are ready to compile nightshade sources :
untar the tar.gz archive
~$ tar -xzf nightshade-XXX.tar.gz
~$ cd nightshade

then type
~$ ./configure
~$ make

then to launch the local version of the program type
~$ ./src/nightshade

to fully install nightshade (so that it will be launchable from everywhere) type as root
~$ make install

once installed you may want to clean the build directory
~$ make clean

If you want to uninstall nightshade, type as root
~$ make uninstall


===============================================================================
Special instructions for COMPILATION on MACOSX
===============================================================================

For Intel/OSX based Macs, follow the compilation from source instructions above.
The dependencies may be installed manually or via Macports (recommended).

For convenience, Nightshade can also be installed via Macports.
	-Install Macports from http://www.macports.org/install.php.
	-Open a command prompt.
	-Type the following,
		sudo port install nightshade
	-You will be prompted for the administrator's password

Depending on your system, several dependencies may need to be installed prior
to Nightshade, please be patient while installation proceeds.


===============================================================================
Special instructions for COMPILATION on WINDOWS (XP) with MinGW
===============================================================================

Instructions are being developed.  For now follow MinGW instructions for
building TuxPaint as found on the web.


===============================================================================
              COMPILATION (and modification) from the BZR sources
===============================================================================

You can get the latest bzr repository code from LaunchPad. However with this BZR
version no correct behaviour is garanteed. It is mainly intended for use by
developers.

You can browse the BZR tree at http://code.launchpad.net/nightshade

To create your own local branch (assuming you have installed bzr) type in 
a console:

~$ bzr branch lp:nightshade nightshade 

then to compile type:
~$ cd nightshade
~$ ./autogen.sh
~$ ./configure
~$ make

then to launch the local version of the program type
~$ ./src/nightshade

You can now have a look at the src/ directory where you will find the source files.
Edit whatever you want in it and when your new great feature is done you will need 
to share it with the community of nightshade developers.

To save a revision locally, type:

~$ bzr commit -m "Some comment about your change"

While you are working you can get new changes from the main trunk by typing:

~$ bzr merge

When you are satisfied with your changes, an official developer will need to review 
your changes for inclusion.  But as you are not an official developer (yet!) you 
will need to create a patch file which will contain all the changes you did on the 
source code.

~$ bzr send -o description-of-my-change.patch

Then email the patch to support@nightshadesoftware.org!




