aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-08-21 21:14:33 +0100
committerYann Herklotz <ymherklotz@gmail.com>2017-08-21 21:14:33 +0100
commit34f910351863163438c419dd07045f1442321293 (patch)
treefef58eb6e2bd8c82dc3fce74088b4c4cee156900 /README.md
parent4b95a1ac4265e2f51bf78969ce259f0f8b91fd91 (diff)
downloadYAGE-34f910351863163438c419dd07045f1442321293.tar.gz
YAGE-34f910351863163438c419dd07045f1442321293.zip
Filling out readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
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
-------