Read Me

################################################################################
# licence

Rubygame Pong - A Pong clone written in Ruby using Rubygame
Copyright (C) 2010  Christoph Traut

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

################################################################################
# project description

Rubypong is a simple Pong clone written in Ruby using Rubygame.


################################################################################
# project page

https://sourceforge.net/projects/rubypong/


################################################################################
# info

This game is in a playable state, but I plan to add more features to it.
Most of the ingame settings can be changed by editing the config file in the
project's root directory.


################################################################################
# installation instructions

Depending on the system you are using, there are several ways how you can
install Ruby Pong:
    * There is a Windows installer that will install anything you need.
      It is pretty large though, since it comes with it's own ruby
      interpreter and all required libraries (though they are compressed).
      Once you have installed it, you can be pretty sure everything
      just works. The windows installer will NOT interfere in any way
      with an existing installation of Ruby you might already have.

    * For Debian/Ubuntu users there is a .deb package that will install rubygame
      and any dependencies it might require. You can install it easily by using
      gdebi.

    * A port for FreeBSD is in the making.

Of course you can always just download the platform independent source package
and run it yourself. You won't need to compile anything since Ruby Pong is
written a 100% in Ruby. Obviously you will have to install any dependencies
Ruby Pong needs manually.

To run this game you need Ruby, Rubygame and SDL installed.
For detailed installation instructions, see:
    * Ruby:     http://www.ruby-lang.org/
    * Rubygame: http://rubygame.org/wiki/Installation_Instructions


################################################################################
# running the game

you can run this game by either:
    * By running /usr/bin/rubypong after installing the Ruby Pong package.

    * Double-clicking the Ruby Pong icon on your Windows Desktop after you
      successfully run the Windows installer for Ruby Pong.

    * Executing the 'rubypong' script file in the game folder.

    * Running the 'main.rb' file in the 'src' folder with the Ruby interpreter.