diff options
Diffstat (limited to 'md_README.html')
| -rw-r--r-- | md_README.html | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/md_README.html b/md_README.html index a078cbfa..f90f559a 100644 --- a/md_README.html +++ b/md_README.html @@ -93,6 +93,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <p>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. To do this, a Component Entity System will be used to manage the different systems in the game engine and make it as modular as possible. Systems can easily be added to the game engine, and new entities with custom Components can also be created by the user.</p> <p>The game engine also supports asynchronous logging by using an <code>Active</code> class that creates a new thread, and queues any functions that are sent to it. This can help debugging programs, as one can increase the minimum log level of the game engine to any required resolution. This output can also be piped to a file without slowing down the program.</p> <p>The full documentation of the API can be seen <a href="https://www.yannherklotz.com/YAGE">here</a>.</p> +<h3>Purpose</h3> +<p>The purpose of this game engine is not to be very general, but easy to use and quick to initially set up.</p> <h2>Installation and usage</h2> <p>To use YAGE for your own game, you should link it as a static library and include the <a href="/yage/yage.h">yage.h</a> 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 <code>yage</code>.</p> <h2>Build and Testing</h2> @@ -113,7 +115,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Fri Apr 6 2018 14:48:50 by  <a href="http://www.doxygen.org/index.html"> +Generated on Sat May 19 2018 14:24:12 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> |