From 418f45f78bbf743021c53030da2ad2158fa355d2 Mon Sep 17 00:00:00 2001
From: Frederico Linhares <fred@linhares.blue>
Date: Tue, 29 Mar 2022 11:51:11 -0300
Subject: Initial commit

---
 README.markdown | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.markdown

(limited to 'README.markdown')

diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..6785d0d
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,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`.
-- 
cgit v1.2.3