Skip to content

Commit

Permalink
Improved the documents page. Added Getting Started page to the docume…
Browse files Browse the repository at this point in the history 
…nts.
  • Loading branch information
@erayzesen
erayzesen committed Sep 12, 2024
1 parent bc38fca commit 591d19f
Show file tree
Hide file tree
Showing 1,344 changed files with 81,303 additions and 1,267 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = "QuarkPhysics" "QuarkPhysics/extensions" "doxy_pages"
INPUT = "QuarkPhysics" "QuarkPhysics/extensions" "./doxy_pages"

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
133 changes: 133 additions & 0 deletions documentation/Getting.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Quark Physics: Started</title>
<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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome-custom-qp.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="tweeks.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo_x2.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Quark Physics
&#160;<span id="projectnumber">v1.0</span>
</div>
<div id="projectbrief">2D Rigid and Soft Body Physics Engine</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Getting.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Started </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>QuarkPhysics is a 2D physics engine designed for games. Its goal is to provide a reasonable approach to simulate rigid bodies, soft bodies, and different physics models together.</p>
<p><a href="https://github.com/erayzesen/QuarkPhysics">Project Github Page</a></p>
<h2><a class="anchor" id="autotoc_md0"></a>
Concept Map</h2>
<p>
<div style="text-align: center; background-color: transparent; max-width: 500px">
<object type="image/svg+xml" data="../doxy_pages/images/concept.svg" style="width: 100%; height: auto; background-color: transparent;">
Your browser does not support SVG.
</object>
</div>

</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Building Examples</h2>
<p>You need to install <a href="https://www.sfml-dev.org/">SFML</a> and <a href="https://cmake.org/">CMake</a> on your system before.</p>
<p>Download project, enter the main folder and call this; </p><pre class="fragment"> ./build.sh -r
</pre><p> Another way is that compiling the project directly via gcc if you're on linux call; </p><pre class="fragment"> ./run_linux_fast.sh -r
</pre> <h2><a class="anchor" id="autotoc_md2"></a>
Using</h2>
<p>Copy the "QuarkPhysics" named subfolder in the main folder to your project and use it.</p>
<h2><a class="anchor" id="autotoc_md3"></a>
Third Party</h2>
<ul>
<li><a href="https://github.com/nlohmann/json">nlohmann's json</a> for the json parsing. (Importing meshes via *.qmesh files)</li>
<li><a href="https://www.sfml-dev.org/">SFML</a> library for window,input,opengl.</li>
</ul>
<h2><a class="anchor" id="autotoc_md4"></a>
License</h2>
<p>Licensed under the <a href="https://github.com/erayzesen/QuarkPhysics/blob/master/LICENSE">MIT</a> license. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
19 changes: 14 additions & 5 deletions documentation/annotated_dup.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
var annotated_dup =
[
[ "Concept Map", "index.html#autotoc_md0", null ],
[ "Building Examples", "index.html#autotoc_md1", null ],
[ "Using", "index.html#autotoc_md2", null ],
[ "Third Party", "index.html#autotoc_md3", null ],
[ "License", "index.html#autotoc_md4", null ],
[ "Concept Map", "index.html#autotoc_md8", null ],
[ "Building Examples", "index.html#autotoc_md9", null ],
[ "Using", "index.html#autotoc_md10", null ],
[ "Third Party", "index.html#autotoc_md11", null ],
[ "License", "index.html#autotoc_md12", null ],
[ "Creating a World", "getting_started.html#autotoc_md0", null ],
[ "Creating a Rigid Body", "getting_started.html#autotoc_md1", null ],
[ "Creating a Soft Body", "getting_started.html#autotoc_md2", [
[ "Addinational QMesh features for Soft Bodies", "getting_started.html#autotoc_md3", null ]
] ],
[ "Creating a Joint", "getting_started.html#autotoc_md4", null ],
[ "Creating a Spring", "getting_started.html#autotoc_md5", null ],
[ "Removing Bodies, Joints and Springs from the World", "getting_started.html#autotoc_md6", null ],
[ "Summary", "getting_started.html#autotoc_md7", null ],
[ "QAABB", "classQAABB.html", "classQAABB" ],
[ "QAreaBody", "classQAreaBody.html", "classQAreaBody" ],
[ "QBody", "classQBody.html", "classQBody" ],
Expand Down
Loading

0 comments on commit 591d19f

Please sign in to comment.