diff options
| author | TravisBot <> | 2018-03-10 21:26:07 +0000 |
|---|---|---|
| committer | TravisBot <> | 2018-03-10 21:26:07 +0000 |
| commit | 4a5f0d81b8396403eec66d2be90b0f7c0966e0b2 (patch) | |
| tree | bcfadddb64dc24bc442a611acbc4c6b047f31dd5 /md_README.html | |
| parent | 293d16f9dc40b4ebfa18b45e17261fc923bba98f (diff) | |
| download | YAGE-4a5f0d81b8396403eec66d2be90b0f7c0966e0b2.tar.gz YAGE-4a5f0d81b8396403eec66d2be90b0f7c0966e0b2.zip | |
[Travis] Rebuilding documentation
Diffstat (limited to 'md_README.html')
| -rw-r--r-- | md_README.html | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/md_README.html b/md_README.html index 4ca1469b..44981ce8 100644 --- a/md_README.html +++ b/md_README.html @@ -99,6 +99,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <p>``` shell mkdir -p build cd build cmake .. ```</p> <p>The test suite can then be run using</p> <p>``` shell cd build/tests && ctest ```</p> +<h2>Using the game engine</h2> +<p>The game engine can be initialised as follows.</p> +<p>``` c++ <a class="el" href="namespaceyage.html#a4fc8b4d2a19d4c7f7f1bd42a788827ce" title="Initializes YAGE. ">yage::init()</a>; ```</p> +<p>It can be then cleaned up by running.</p> +<p>``` objective-c++ <a class="el" href="namespaceyage.html#ac9d8c7327204686b3c86f4ab48672618" title="Quit and cleanup YAGE. ">yage::quit()</a>; ```</p> <h2>Future Improvements</h2> <p>The first step is to have full support of 3D meshes with their corresponding textures, and making a useful API to interact with the 3D YAGE library.</p> <p>Secondly, improvements to the Entity Component System</p> @@ -107,7 +112,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Tue Feb 13 2018 20:22:05 for YAGE by  <a href="http://www.doxygen.org/index.html"> +Generated on Sat Mar 10 2018 21:25:05 for YAGE by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> |