History

Code »

Getting Started

This guide should help anyone get their computer ready to begin contributing. Please read the Coding Standards before contributing.

Install

GCC

[GCC]
  1. Download GCC 4.4.x
  2. Follow the installation guide

For Windows

  1. Download MinGW
  2. The current MinGW version only comes with GCC 3.4.5 so it is necessary to manually update it
  3. Download:
  1. You will also need the current GDB version if you intend to use this for debugging; the old version will not be able to parse the source annotation correctly.
  2. Extract the contents of the files into the MinGW install directory (usually C:\MinGW). This will replace your current version of GCC.

For Mac

  1. Simply install XCode from the disc that comes bundled with your Mac, or download it here.

SFML

[SFML]

For Ubuntu

>{{$ cd /path/to/SFML-folder/
>$ sudo apt-get build-dep libsfml
>$ sudo make install}}

For Windows and Mac

  1. Download SFML 1.5
  2. Follow the Getting Started tutorial for your platform

Python

[Python]
  1. Download Python 2.6.x
  2. Follow this installation guide

Boost

[Boost]

For Ubuntu

  • Install the following if you're running 32-bit:
>{{$ sudo apt-get install python2.6-dev zlib1g-dev zlib1g-dbg libbz2-dev}}
  • Install the following if you're running 64-bit:
>{{$ sudo apt-get install python2.6-dev zlib1g-dev zlib1g-dbg lib32bz2-dev}}

>{{$ tar --bzip2 -xf /path/to/boost_1_41_0.tar.bz2
>$ cd /path/to/boost_1_41_0/
>$ sudo ./bootstrap.sh && sudo ./bjam && sudo bjam install}}

For Windows

  1. Download Boost
  2. Follow the Getting Started Guide for Windows

For Mac

  1. Download Boost]
  2. Follow the Getting Started Guide for Unix Variants
  3. Move the "boost" directory into /Library/Frameworks

Box2D 2.0.1

[Box 2D 2.0.1]

For Ubuntu

>{{$ sudo apt-get install libbox2d0 libbox2d-dev libbox2d0-dbg}}

For Windows

  1. Download
  2. Box2D Wiki

Git

[Git]

For Ubuntu

>{{$ sudo apt-get install git-core}}

For Mac

  1. Download and install through MacPorts

For Windows

  1. Download msysgit and run the installer
  2. Download TortoiseGIT and run the installer

Getting Git Set Up

  1. Visit GitHub and register an account
  2. Set up your SSH
  1. Set up your user name, email, and GitHub token
  2. Fork kitchen's repository
  3. Then clone your newly created repository using the following command:
> {{$ git clone git@github.com:YOUR_ACCOUNT/Machine.git machine}}

Compiling and Running Machine

Checkout the latest version of the repository and run the following commands: 
> {{$ cd /path/to/machine/src/
> $ make run}}

Also available in: HTML TXT