From 84b1f965b52ffd071c873a497d4139ad4baa9c6b Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Sat, 10 Mar 2018 21:16:39 +0000
Subject: [Doc] Adding documentation

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'README.md')

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
-- 
cgit