aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2018-03-10 21:16:39 +0000
committerYann Herklotz <ymherklotz@gmail.com>2018-03-10 21:16:39 +0000
commit84b1f965b52ffd071c873a497d4139ad4baa9c6b (patch)
treebe56f73dfff31812d2e79b1f8e0741ef0b6af47c
parent2fe3434682aae38bb0ab414135c2311110a6db90 (diff)
downloadYAGE-84b1f965b52ffd071c873a497d4139ad4baa9c6b.tar.gz
YAGE-84b1f965b52ffd071c873a497d4139ad4baa9c6b.zip
[Doc] Adding documentation
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0ad73d6f..ba834959 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,20 @@ The test suite can then be run using
cd build/tests && ctest
```
+## Using the game engine
+
+The game engine can be initialised as follows.
+
+``` c++
+yage::init();
+```
+
+It can be then cleaned up by running.
+
+``` objective-c++
+yage::quit();
+```
+
## Future Improvements
The first step is to have full support of 3D meshes with their corresponding