This guide should help anyone get their computer ready to begin contributing. Please read the Coding Standard before contributing.
Want to start hacking?
Use your favorite torrent client to download the RMAG development VM, designed for use with Virtualbox. After extracting, tell Vbox to Import Appliance to get started.
Install
GCC
- Download GCC 4.4.x
- Follow the installation guide
For Windows
- Download MinGW
- The current MinGW version only comes with GCC 3.4.5 so it is necessary to manually update it
- Download GMP runtime, libiconv, MPFR runtime, POSIX Threads for Win32 runtime, GCC core DLLs, GCC core binaries, G++ DLLs, G++ binaries
- 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.
- Extract the contents of the files into the MinGW install directory (usually C:\MinGW). This will replace your current version of GCC.
For Mac
- Simply install XCode from the disc that comes bundled with your Mac, or download it here.
SFML
For Ubuntu
- Download SFML 1.5
- Extract the files
$ cd /path/to/SFML-folder/
$ sudo apt-get build-dep libsfml
$ sudo make install
For Windows and Mac
- Download SFML 1.5
- Follow the Getting Started tutorial for your platform
Python
- Download Python 2.6.x
- Follow this installation guide
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
- Download Boost 1.41
$ 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
- Download Boost
- Follow the Getting Started Guide for Windows
For Mac
- Download Boost
- Follow the Getting Started Guide for Unix Variants
- Move the "boost" directory into /Library/Frameworks
Box2D 2.0.1
For Ubuntu
$ sudo apt-get install libbox2d0 libbox2d-dev libbox2d0-dbg
For Windows
Git
For Ubuntu
$ sudo apt-get install git-core
For Mac
- Download and install through MacPorts
For Windows
- Download msysgit and run the installer
- Download TortoiseGIT and run the installer
Getting Git Set Up
- Visit GitHub and register an account
- Set up your SSH
- Set up your user name, email, and GitHub token
- Fork kitchen's repository
- Then clone your newly created repository using the following command:
$ git clone moc.buhtig|tig#moc.buhtig|tig: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
