aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-08-23 20:33:34 +0100
committerYann Herklotz <ymherklotz@gmail.com>2017-08-23 20:33:34 +0100
commit56b5466f014d9f7c3662544713bd53670cd8e32f (patch)
tree479658b1424c53d3e1ceaadb16b095bb34531520 /README.md
parent34f910351863163438c419dd07045f1442321293 (diff)
downloadYAGE-56b5466f014d9f7c3662544713bd53670cd8e32f.tar.gz
YAGE-56b5466f014d9f7c3662544713bd53670cd8e32f.zip
Applied modernize rules and fixed build.
Applied clang-tidy modernize rules and fixed the CMakeLists.txt file so that it also linked against the SDL2 library.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index 17176786..96a0ad70 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,25 @@
YAGE
====
-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).
+Introduction
+------------
-YAGE uses OpenGL and SDL2 for the window creation and management and graphics.
+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).
+It uses OpenGL and SDL2 for the window creation and management and graphics.
-Installation and Usage
+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).
+To use YAGE for your own game, you should link it as a static library and
+include the [yage.hpp](/include/YAGE/yage.hpp) 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](/CMakeLists.txt).
``` shell
mkdir build