Skip to content

Commit

Permalink
Updated documentation pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Aug 11, 2024
1 parent 31bd7e8 commit f94b7d6
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/goblin3d_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
<li>Pre-calculate the 3D coordinates based on rotation angles.</li>
<li>Render the 3D objects onto a 2D surface.</li>
</ul>
<h2><a class="anchor" id="autotoc_md3"></a>
<h2><a class="anchor" id="autotoc_md0"></a>
Usage Example</h2>
<div class="fragment"><div class="line"><a class="code hl_struct" href="structgoblin3d__obj__t.html">goblin3d_obj_t</a> cube;</div>
<div class="line"><a class="code hl_function" href="goblin3d_8h.html#a8dcba9fbaaaae19b78d1913c749a5ba9">goblin3d_init</a>(&amp;cube, 8, 12);</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><ul><li class="level2"><a href="#autotoc_md0">Features</a></li>
<li class="level2"><a href="#autotoc_md1">Installation</a><ul><li class="level3"><a href="#autotoc_md2">Arduino Library Manager</a></li>
<ul><ul><li class="level2"><a href="#autotoc_md1">Features</a></li>
<li class="level2"><a href="#autotoc_md2">Installation</a><ul><li class="level3"><a href="#autotoc_md3">Arduino Library Manager</a></li>
<li class="level3"><a href="#autotoc_md4">Manual Installation</a></li>
</ul>
</li>
Expand All @@ -112,9 +112,9 @@
</div><div align="center"> </div><p ><img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_ci.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/goblin3d/actions/workflows/sdl2_ci.yml/badge.svg" alt="SDL2 Port CI" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-v0.0.1-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/goblin3d/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" style="pointer-events: none;" class="inline"/></a></p>
<p ><b>Goblin3D</b> is a lightweight, dependency-free graphics engine designed for rendering 3D wireframes on monochromatic displays and TFT LCDs using the Arduino platform. Goblin3D is perfect for embedded systems where resources are limited but 3D rendering capabilities are desired.</p>
<p align="center"></p>
<p ><img src="assets/goblin3d_demo.jpg" alt="Goblin3D demo" width="480" class="inline"/> <br />
<p ><img src="https://raw.githubusercontent.com/nthnn/goblin3d/main/assets/goblin3d_demo.jpg" alt="Goblin3D demo" width="480" class="inline"/> <br />
Goblin3D demo with ESP32 on TFT and OLED. </p>
<h2><a class="anchor" id="autotoc_md0"></a>
<h2><a class="anchor" id="autotoc_md1"></a>
Features</h2>
<ul>
<li><b>3D Wireframe Rendering</b>: Render basic 3D shapes as wireframes on displays.</li>
Expand All @@ -123,11 +123,11 @@ <h2><a class="anchor" id="autotoc_md0"></a>
<li><b>Customizable Objects</b>: Easily define and manipulate custom 3D objects with your own vertices and edges.</li>
<li><b>Rotation and Scaling</b>: Support for rotating and scaling objects in 3D space.</li>
</ul>
<p ><img src="assets/goblin3d_sdl2.png" alt="Goblin3D port with SDL2" class="inline"/> <br />
<p ><img src="https://raw.githubusercontent.com/nthnn/goblin3d/main/assets/goblin3d_sdl2.png" alt="Goblin3D port with SDL2" class="inline"/> <br />
Goblin3D port with SDL2 </p>
<h2><a class="anchor" id="autotoc_md1"></a>
<h2><a class="anchor" id="autotoc_md2"></a>
Installation</h2>
<h3><a class="anchor" id="autotoc_md2"></a>
<h3><a class="anchor" id="autotoc_md3"></a>
Arduino Library Manager</h3>
<ol type="1">
<li>Open the Arduino IDE.</li>
Expand Down
6 changes: 3 additions & 3 deletions docs/navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ var NAVTREE =
[
[ "Goblin3D", "index.html", [
[ "Classes", "annotated.html", [
[ "Features", "index.html#autotoc_md0", null ],
[ "Installation", "index.html#autotoc_md1", [
[ "Arduino Library Manager", "index.html#autotoc_md2", null ],
[ "Features", "index.html#autotoc_md1", null ],
[ "Installation", "index.html#autotoc_md2", [
[ "Arduino Library Manager", "index.html#autotoc_md3", null ],
[ "Manual Installation", "index.html#autotoc_md4", null ]
] ],
[ "Getting Started", "index.html#autotoc_md5", [
Expand Down
6 changes: 3 additions & 3 deletions docs/navtreeindex0.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ var NAVTREEINDEX0 =
"goblin3d_8h.html#adef913d7db7d1970e0595d05c10419a4":[1,0,0,0,5],
"goblin3d_8h_source.html":[1,0,0,0],
"index.html":[],
"index.html#autotoc_md0":[0],
"index.html#autotoc_md1":[1],
"index.html#autotoc_md2":[1,0],
"index.html#autotoc_md1":[0],
"index.html#autotoc_md2":[1],
"index.html#autotoc_md3":[1,0],
"index.html#autotoc_md4":[1,1],
"index.html#autotoc_md5":[2],
"index.html#autotoc_md6":[2,0],
Expand Down

0 comments on commit f94b7d6

Please sign in to comment.