aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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