From 72b41042223bfe31d70df8a71a50e4ba5d4f674d Mon Sep 17 00:00:00 2001 From: TravisBot <> Date: Sat, 23 Dec 2017 01:02:37 +0000 Subject: [Travis] Rebuilding documentation --- index.html | 132 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 index.html (limited to 'index.html') diff --git a/index.html b/index.html new file mode 100644 index 00000000..5f87cba4 --- /dev/null +++ b/index.html @@ -0,0 +1,132 @@ + + +
+ + + +
+ YAGE
+ v0.1.3.0
+
+ Yet Another Game Engine
+ |
+
YAGE stands for Yet Another Game Engine. It is a game engine that is being developed for a game called Arider. It uses OpenGL and GLFW for the window creation and management and graphics. It is also going to be a general game engine for use with other games in the similar style.
+The inspiration for this game engine is to learn about OpenGL and create an optimised 2D game engine with a simple API that can be used to easily create simple 2D games.
+The full documentation can be seen here.
+To use YAGE for your own game, you should link it as a static library and include the yage.h header in your project. To link the project using cmake, the library has to be added as a subdirectory and then linked with the name yage
.
To compile YAGE, create a build directory from the base directory. Then call cmake and point it to the directory containing. CMakeLists.txt. For example, one can use the following commands
+``` shell mkdir -p build cd build cmake .. ```
+The test suite can then be run using
+``` shell cd build/tests && ctest ```
+Copyright (c) 2017 Yann Herklotz Grave ymher – MIT License, see file klot z@gma il.c omLICENSE for more details.
+