From 8ad8165816929301a87e90bbb32c3df6b69030ee Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sat, 2 Sep 2017 12:28:11 +0100 Subject: Updating docs --- index.html | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'index.html') diff --git a/index.html b/index.html index 72778c1b..dffc1621 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ -YAGE: Main Page +YAGE: YAGE @@ -29,7 +29,7 @@
YAGE -  0.02 +  v0.1.1
Yet Another Game Engine
@@ -82,15 +82,25 @@ $(document).ready(function(){initNavTree('index.html','');});
-
YAGE Documentation
+
YAGE
-
+

Introduction

+

YAGE stands for Yet Another Game Engine. It is a game engine that I am developing for a game called Arider. It uses OpenGL and SDL2 for the window creation and management and graphics.

+

The full documentation can be seen here.

+

Installation and usage

+

To use YAGE for your own game, you should link it as a static library and include the yage.h 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.

+
mkdir build
cd build
cmake ..

You can then run google test on YAGE.

+
ctest

License

+

Copyright (c) 2017 Yann Herklotz Grave ymher.nosp@m.klot.nosp@m.z@gma.nosp@m.il.c.nosp@m.om – MIT License, see file LICENSE for more details.

+