From 9683f2c7488d0841f68ad1379b8e146db50bcf6b Mon Sep 17 00:00:00 2001 From: Nathanne Isip Date: Mon, 12 Aug 2024 02:25:18 +0800 Subject: [PATCH] Updated documentation pages. --- docs/goblin3d_8h.html | 4 ++-- docs/index.html | 26 ++++++++++++++++---------- docs/navtreedata.js | 11 ++++++----- docs/navtreeindex0.js | 13 +++++++------ 4 files changed, 31 insertions(+), 23 deletions(-) diff --git a/docs/goblin3d_8h.html b/docs/goblin3d_8h.html index 8f5e662..41baecf 100644 --- a/docs/goblin3d_8h.html +++ b/docs/goblin3d_8h.html @@ -142,7 +142,7 @@
  • Pre-calculate the 3D coordinates based on rotation angles.
  • Render the 3D objects onto a 2D surface.
    • -

    +

    Usage Example

    goblin3d_obj_t cube;
    goblin3d_init(&cube, 8, 12);
    @@ -278,7 +278,7 @@

    +

    Mathematical Representation

    The rotation matrices for the X, Y, and Z axes are as follows:

      diff --git a/docs/index.html b/docs/index.html index 2a417ef..9c78998 100644 --- a/docs/index.html +++ b/docs/index.html @@ -95,12 +95,13 @@

    Table of Contents

    -
      • Features
        • -
      • Installation
        • Arduino Library Manager
          • -
        • Manual Installation
          • +
            • Features
              • +
            • Installation
              • -
            • Getting Started
              • Basic Usage
                • +
              • Getting Started
              • Contribution and Feedback
                • @@ -114,7 +115,7 @@

                Goblin3D demo
                Goblin3D demo with ESP32 on TFT and OLED.

                -

                +

                Features

                • 3D Wireframe Rendering: Render basic 3D shapes as wireframes on displays.
                  • @@ -125,9 +126,9 @@

                Goblin3D port with SDL2
                Goblin3D port with SDL2

                -

                +

                Installation

                -

                +

                Arduino Library Manager

                1. Open the Arduino IDE.
                  2. @@ -135,7 +136,7 @@

                2. Search for Goblin3D.
                3. Click Install.

                -

                +

                Manual Installation

                1. Download the latest release from the Releases page.
                  2. @@ -143,9 +144,14 @@

                2. Move the Goblin3D folder to your Arduino libraries directory (typically ~/Documents/Arduino/libraries/ on Windows and Linux, ~/Documents/Arduino/libraries/ on macOS).
                3. Restart the Arduino IDE.

                -

                +

                Getting Started

                -

                +

                +Quick Start

                +

                Goblin3D SDL2 port example is availble on Docker to try it out.

                +
                docker pull nthnn/goblin3d
                +
                docker run -it -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix goblin3d
                +

                Basic Usage

                Here’s a simple example of how to use Goblin3D to render a rotating 3D house-shape object on an OLED display:

                #include <Adafruit_SSD1306.h> // Include the library for SSD1306 OLED display
                diff --git a/docs/navtreedata.js b/docs/navtreedata.js index fe2f520..4ae4079 100644 --- a/docs/navtreedata.js +++ b/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 ], diff --git a/docs/navtreeindex0.js b/docs/navtreeindex0.js index c2d0665..24cea54 100644 --- a/docs/navtreeindex0.js +++ b/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":[],