aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.travis.yml32
-rw-r--r--README.md19
2 files changed, 30 insertions, 21 deletions
diff --git a/.travis.yml b/.travis.yml
index 827fed4b..399ab0d8 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -103,21 +103,21 @@ matrix:
env:
- "MATRIX_EVAL=\"CC=clang-5.0 && CXX=clang++-5.0\""
os: linux
- -
- env:
- - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc5 && CC=gcc-5 && CXX=g++-5\""
- os: osx
- osx_image: xcode8
- -
- env:
- - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc6 && CC=gcc-6 && CXX=g++-6\""
- os: osx
- osx_image: xcode8
- -
- env:
- - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc && CC=gcc-7 && CXX=g++-7\""
- os: osx
- osx_image: xcode8
+# -
+# env:
+# - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc5 && CC=gcc-5 && CXX=g++-5\""
+# os: osx
+# osx_image: xcode8
+# -
+# env:
+# - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc6 && CC=gcc-6 && CXX=g++-6\""
+# os: osx
+# osx_image: xcode8
+# -
+# env:
+# - "MATRIX_EVAL=\"rvm install ruby-2.3.3 && rvm use 2.3.3 && brew update && brew install gcc && CC=gcc-7 && CXX=g++-7\""
+# os: osx
+# osx_image: xcode8
notifications:
email: false
script:
@@ -127,7 +127,7 @@ script:
- "mkdir -p build"
- "cd build"
- "cmake -DUNIT_TESTS=ON .."
- - make
+ - "make -j9"
- ctest
- "cd .. && ./scripts/update_docs"
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.