summaryrefslogtreecommitdiff
path: root/README.markdown
blob: 6785d0d36fa28204890e3eacfe2c9f1cf684eb71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
CandyGear
=========

CandyGear is a 2D game engine for mruby, and it is built on top of SDL. It aims to be very flexible and make the development of small games straightforward.

Installation
------------

CandyGear uses the libraries libSDL2, SDL2\_image, SDL2\_mixer, libSDL2\_ttf, and yaml-cpp, so before installing CandyGear into a machine, ensure that development libraries for SDL are installed.
CandyGear is compiled with Ruby Rake; also ensure it is installed.
To compile the code, run `rake` at the root directory; it will generate the binary engine.
To install the core, run `rake install`.