diff options
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -30,7 +30,7 @@ <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">YAGE -  <span id="projectnumber">v0.3.1</span> +  <span id="projectnumber">v0.1.3</span> </div> <div id="projectbrief">Yet Another Game Engine</div> </td> @@ -106,13 +106,14 @@ $(document).ready(function(){initNavTree('index.html','');}); <img src="https://travis-ci.org/ymherklotz/YAGE.svg?branch=master" alt="master-build"/> </div> <h2>Introduction </h2> -<p>YAGE stands for Yet Another Game Engine. It is a game engine that I am developing for a game called <a href="https://github.com/ymherklotz/Arider">Arider</a>. It uses OpenGL and GLFW for the window creation and management and graphics.</p> +<p>YAGE stands for Yet Another Game Engine. It is a game engine that is being developed for a game called <a href="https://github.com/ymherklotz/Arider">Arider</a>. It uses OpenGL and GLFW for the window creation and management and graphics. It is also going to be a general game engine for use with other games in the similar style.</p> +<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.</p> <p>The full documentation can be seen <a href="https://www.yannherklotz.com/YAGE">here</a>.</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="/include/YAGE/yage.h">yage.h</a> header in your project.</p> +<p>To use YAGE for your own game, you should link it as a static library and include the <a href="/include/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> -<p>To compile YAGE, create a build directory from the base directory. Then call cmake and point it to the directory containing. <a href="/CMakeLists.txt">CMakeLists.txt</a>.</p> -<p>``` shell mkdir build cd build cmake .. -DENABLE_TESTING=1 ```</p> +<p>To compile YAGE, create a build directory from the base directory. Then call cmake and point it to the directory containing. <a href="/CMakeLists.txt">CMakeLists.txt</a>. For example, one can use the following commands</p> +<p>``` shell mkdir -p build cd build cmake -DENABLE_TESTING=1 .. ```</p> <p>You can then run google test on YAGE.</p> <p>``` shell ctest ```</p> <h2>License </h2> @@ -122,7 +123,7 @@ $(document).ready(function(){initNavTree('index.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Sun Dec 17 2017 12:31:08 for YAGE by + <li class="footer">Generated on Wed Dec 20 2017 18:02:10 for YAGE by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> </ul> |