From 34f910351863163438c419dd07045f1442321293 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Mon, 21 Aug 2017 21:14:33 +0100 Subject: Filling out readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d31829a2..17176786 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,26 @@ YAGE ==== -YAGE stands for Yet Another Game Engine. +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). + +YAGE uses OpenGL and SDL2 for the window creation and management and graphics. + +Installation and Usage +---------------------- + +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 ------- -- cgit