From a28da7ef1a42cddd42f60220708eb5d36ea18d12 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sun, 17 Dec 2017 12:13:14 +0000 Subject: Mores to travis --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 724e5e5a..882f37dd 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,15 @@ YAGE {#mainpage} 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). +YAGE stands for Yet Another Game Engine. It is a game engine that is being +developed for a game called [Arider](https://github.com/ymherklotz/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](https://www.yannherklotz.com/YAGE). @@ -15,7 +21,9 @@ Installation and usage ---------------------- To use YAGE for your own game, you should link it as a static library and -include the [yage.h](/include/YAGE/yage.h) header in your project. +include the [yage.h](/include/YAGE/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`. Build and Testing ----------------- @@ -23,11 +31,12 @@ 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). +For example, one can use the following commands ``` shell -mkdir build +mkdir -p build cd build -cmake .. -DENABLE_TESTING=1 +cmake -DENABLE_TESTING=1 .. ``` You can then run google test on YAGE. -- cgit