 ===================================================
  Guide for installing Brum Brum Rally on GNU/Linux
 ===================================================

Preparations:
-------------
If you are an experienced Linux user you can skip this section.

While following this guide you will be typing a number of commands at
the terminal (also called a console). If you don't have a terminal
window open already, now is a good time to open one.

You also need set the current working directory to the game's root
directory (same directory as this file) by using the `cd' command.

    cd path/to/gamedir

Some commands need to run as root to get extra privileges. Exactly how
you do this depends on how your system is set up. If the command 
`example arg1 arg2' is said to be run as root, you could try:

    sudo example arg1 arg2

If that doesn't work, try:

    su -c "example arg1 arg2"


Requirements:
-------------
To compile this game you need:

 g++        - The GCC C++ compiler
 SDL 1.2    - Simple DirectMedia Layer
  SDL_image
  SDL_net
 make       - A GNU tool which simplifies the build process

In most cases you will find all of these in the package manager of your
distribution so there shouldn't be a need to compile anything manually.

In Debian, Ubuntu, Linux Mint and similar distributions you can install
everything by running (as root):

    apt-get install g++ libsdl-image1.2-dev libsdl-net1.2-dev make 

In Fedora you can install everything by running (as root):

    yum install gcc-c++ SDL_image-devel SDL_net-devel make

In openSUSE you can install everything by running (as root):

    zypper install gcc-c++ libSDL_image-devel libSDL_net-devel make

In Arch Linux you can install everything by running (as root):

    pacman -S --needed gcc sdl_image sdl_net make


Compilation:
------------
To compile the game simply run:

    make

This should produce an executable file named `brumbrumrally'. You can
now run the game by typing: 

    ./brumbrumrally


Installation:
-------------
To install the game run (as root):

    make install

After the game has been installed you should be able to find it in the
desktop menus and be able to run it from anywhere by typing:

    brumbrumrally

If you can't find the game in the menus you might have to wait until the
next time you log in for the menus to update properly.

You can now delete the game directory if you want. All files needed to
run the game has been copied to other directories by the installation.

If you wish to uninstall the game, you can do so by running (as root):

    make uninstall

