aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-12-17 12:13:14 +0000
committerYann Herklotz <ymherklotz@gmail.com>2017-12-17 19:56:30 +0000
commita28da7ef1a42cddd42f60220708eb5d36ea18d12 (patch)
tree1877b3a306c0376947b6e799cef61e4879e34bea /README.md
parenta44129fe480762294ad072667b796abd59d22df2 (diff)
downloadYAGE-a28da7ef1a42cddd42f60220708eb5d36ea18d12.tar.gz
YAGE-a28da7ef1a42cddd42f60220708eb5d36ea18d12.zip
Mores to travis
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
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.