diff options
Diffstat (limited to 'md_README.html')
| -rw-r--r-- | md_README.html | 46 |
1 files changed, 38 insertions, 8 deletions
diff --git a/md_README.html b/md_README.html index 1d9723ac..f4333be9 100644 --- a/md_README.html +++ b/md_README.html @@ -9,6 +9,13 @@ <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> @@ -44,6 +51,21 @@ $(function() { }); </script> <div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('md_README.html','');}); +</script> +<div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -58,21 +80,29 @@ $(function() { </iframe> </div> -</div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">YAGE </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>YAGE stands for Yet Another Game Engine.</p> -<h2>License </h2> +<div class="textblock"><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 SDL2 for the window creation and management and graphics.</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.hpp">yage.hpp</a> header in your project.</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> +<div class="fragment"><div class="line">mkdir build</div><div class="line">cd build</div><div class="line">cmake ..</div></div><!-- fragment --><p>You can then run google test on YAGE.</p> +<div class="fragment"><div class="line">ctest</div></div><!-- fragment --><h2>License </h2> <p>Copyright (c) 2017 Yann Herklotz Grave <a href="#" onclick="location.href='mai'+'lto:'+'ymh'+'er'+'klo'+'tz'+'@gm'+'ai'+'l.c'+'om'; return false;">ymher<span style="display: none;">.nosp@m.</span>klot<span style="display: none;">.nosp@m.</span>z@gma<span style="display: none;">.nosp@m.</span>il.c<span style="display: none;">.nosp@m.</span>om</a> – MIT License, see file <a href="/LICENSE">LICENSE</a> for more details. </p> </div></div><!-- contents --> +</div><!-- doc-content --> <!-- start footer part --> -<hr class="footer"/><address class="footer"><small> -Generated on Mon Aug 21 2017 20:54:26 for YAGE by  <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.13 -</small></address> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Wed Aug 23 2017 22:56:51 for YAGE by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> </body> </html> |