aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index d31829a2..96a0ad70 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,37 @@
YAGE
====
-YAGE stands for Yet Another Game Engine.
+Introduction
+------------
+
+YAGE stands for Yet Another Game Engine. It is a game engine that I am
+developing for a game called [Arider](https://github.com/ymherklotz/Arider).
+It uses OpenGL and SDL2 for the window creation and management and graphics.
+
+Installation and usage
+----------------------
+
+To use YAGE for your own game, you should link it as a static library and
+include the [yage.hpp](/include/YAGE/yage.hpp) header in your project.
+
+Build and Testing
+-----------------
+
+To compile YAGE, create a build directory from the base directory. Then call
+cmake and point it to the directory containing.
+[CMakeLists.txt](/CMakeLists.txt).
+
+``` shell
+mkdir build
+cd build
+cmake ..
+```
+
+You can then run google test on YAGE.
+
+``` shell
+ctest
+```
License
-------