diff options
| author | Frederico Linhares <fred@linhares.blue> | 2023-01-28 11:56:34 -0300 |
|---|---|---|
| committer | Frederico Linhares <fred@linhares.blue> | 2023-01-28 11:56:34 -0300 |
| commit | 63748c1035d3fb39ad7b6ab1f6ad1f829ed85758 (patch) | |
| tree | a61c86d3652b77b0d0ec81223140c40a4e58e31d | |
| parent | 704858045b4f7defb977adb8344ae4428cd02081 (diff) | |
docu Update README
| -rw-r--r-- | README.markdown | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown index 6785d0d..e2c05db 100644 --- a/README.markdown +++ b/README.markdown @@ -1,12 +1,17 @@ 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. +Candy Gear is a 2D and 3D game engine for mruby. +Its primary goal is to work as a minimalistic facade between the game and the system running it (ex.: Linux, Nintendo Switch, PlayStation, etc.). + +Cady Gear aims to be minimalistic yet very flexible. +To achieve this goal, instead of providing a wide range of functionalities with particular uses, it provides a small set of abstract functionalities that do not dictate how to organize your game's code. +However, because of this flexibility, the engine presumes that you have some basic knowledge of algorithms, data structures, and Ruby. 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 uses the libraries libSDL2, SDL2\_mixer, 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`. |