Updated documentation pages.

docs/goblin3d_8h.html

@@ -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_md0"></a>
+<h2><a class="anchor" id="autotoc_md9"></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>
@@ -278,7 +278,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6c722e0a5bff6a8b059c2d2e
 
 <p>Precalculates the rotated and projected points for a 3D object. </p>
 <p >This function applies rotation transformations to the original 3D points and projects them onto a 2D plane. The rotation is applied in the order: X-axis, Y-axis, and Z-axis. The projected points are then scaled and offset based on the object's parameters.</p>
-<h3><a class="anchor" id="autotoc_md9"></a>
+<h3><a class="anchor" id="autotoc_md10"></a>
 Mathematical Representation</h3>
 <p >The rotation matrices for the X, Y, and Z axes are as follows:</p>
 <ul>

docs/index.html

@@ -95,12 +95,13 @@
 </div><!--header-->
 <div class="contents">
 <div class="toc"><h3>Table of Contents</h3>
-<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><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>
+<li class="level3"><a href="#autotoc_md3">Manual Installation</a></li>
 </ul>
 </li>
-<li class="level2"><a href="#autotoc_md5">Getting Started</a><ul><li class="level3"><a href="#autotoc_md6">Basic Usage</a></li>
+<li class="level2"><a href="#autotoc_md4">Getting Started</a><ul><li class="level3"><a href="#autotoc_md5">Quick Start</a></li>
+<li class="level3"><a href="#autotoc_md6">Basic Usage</a></li>
 </ul>
 </li>
 <li class="level2"><a href="#autotoc_md7">Contribution and Feedback</a></li>
@@ -114,7 +115,7 @@
 <p align="center"></p>
 <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_md1"></a>
+<h2><a class="anchor" id="autotoc_md0"></a>
 Features</h2>
 <ul>
 <li><b>3D Wireframe Rendering</b>: Render basic 3D shapes as wireframes on displays.</li>
@@ -125,27 +126,32 @@ <h2><a class="anchor" id="autotoc_md1"></a>
 </ul>
 <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_md2"></a>
+<h2><a class="anchor" id="autotoc_md1"></a>
 Installation</h2>
-<h3><a class="anchor" id="autotoc_md3"></a>
+<h3><a class="anchor" id="autotoc_md2"></a>
 Arduino Library Manager</h3>
 <ol type="1">
 <li>Open the Arduino IDE.</li>
 <li>Go to <b>Sketch</b> &gt; <b>Include Library</b> &gt; <b>Manage Libraries...</b></li>
 <li>Search for <b>Goblin3D</b>.</li>
 <li>Click <b>Install</b>.</li>
 </ol>
-<h3><a class="anchor" id="autotoc_md4"></a>
+<h3><a class="anchor" id="autotoc_md3"></a>
 Manual Installation</h3>
 <ol type="1">
 <li>Download the latest release from the <a href="https://github.com/nthnn/goblin3d/releases">Releases</a> page.</li>
 <li>Unzip the downloaded file.</li>
 <li>Move the <code>Goblin3D</code> folder to your Arduino libraries directory (typically <code>~/Documents/Arduino/libraries/</code> on Windows and Linux, <code>~/Documents/Arduino/libraries/</code> on macOS).</li>
 <li>Restart the Arduino IDE.</li>
 </ol>
-<h2><a class="anchor" id="autotoc_md5"></a>
+<h2><a class="anchor" id="autotoc_md4"></a>
 Getting Started</h2>
-<h3><a class="anchor" id="autotoc_md6"></a>
+<h3><a class="anchor" id="autotoc_md5"></a>
+Quick Start</h3>
+<p >Goblin3D SDL2 port example is availble on Docker to try it out.</p>
+<div class="fragment"><div class="line">docker pull nthnn/goblin3d</div>
+<div class="line">docker run -it -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix goblin3d</div>
+</div><!-- fragment --><h3><a class="anchor" id="autotoc_md6"></a>
 Basic Usage</h3>
 <p >Here’s a simple example of how to use Goblin3D to render a rotating 3D house-shape object on an OLED display:</p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;Adafruit_SSD1306.h&gt;</span> <span class="comment">// Include the library for SSD1306 OLED display</span></div>

docs/navtreedata.js

@@ -26,12 +26,13 @@ var NAVTREE =
 [
  [ "Goblin3D", "index.html", [
  [ "Classes", "annotated.html", [
- [ "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 ]
+ [ "Features", "index.html#autotoc_md0", null ],
+ [ "Installation", "index.html#autotoc_md1", [
+ [ "Arduino Library Manager", "index.html#autotoc_md2", null ],
+ [ "Manual Installation", "index.html#autotoc_md3", null ]
  ] ],
- [ "Getting Started", "index.html#autotoc_md5", [
+ [ "Getting Started", "index.html#autotoc_md4", [
+ [ "Quick Start", "index.html#autotoc_md5", null ],
  [ "Basic Usage", "index.html#autotoc_md6", null ]
  ] ],
  [ "Contribution and Feedback", "index.html#autotoc_md7", null ],

docs/navtreeindex0.js

@@ -17,12 +17,13 @@ var NAVTREEINDEX0 =
 "goblin3d_8h.html#adef913d7db7d1970e0595d05c10419a4":[1,0,0,0,5],
 "goblin3d_8h_source.html":[1,0,0,0],
 "index.html":[],
-"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],
+"index.html#autotoc_md0":[0],
+"index.html#autotoc_md1":[1],
+"index.html#autotoc_md2":[1,0],
+"index.html#autotoc_md3":[1,1],
+"index.html#autotoc_md4":[2],
+"index.html#autotoc_md5":[2,0],
+"index.html#autotoc_md6":[2,1],
 "index.html#autotoc_md7":[3],
 "index.html#autotoc_md8":[4],
 "pages.html":[],