Added gif to installation.rst

docs/_build/html/_sources/installation.rst.txt

@@ -1,6 +1,9 @@
 Installation
 ============
 
+.. image:: ./installation.gif
+   :alt: Installation
+
 * Download the latest release
 * Open Blender and head over to ``Edit`` -> ``Preferences`` -> ``Add-ons`` -> ``Install``
 * Navigate to the downloaded **.zip** file and click ``Install Add-on``
@@ -11,5 +14,5 @@ Installation
     * ``gmsh-api``
     * ``tqdm``
 
-* If you dont have these modules installed, click on ``Install required modules``
+* If you dont have these modules installed, click ``Install required modules``
 

docs/_build/html/_sources/quickstart.rst.txt

@@ -1,2 +1,36 @@
 Quickstart
-==========
+==========
+
+Initialize
+----------
+
+.. figure:: ./ini.png
+    :figwidth: 32%
+    :align: right
+
+* Design space can be initialized via two modes.
+* ``SHAPE`` defines existing geometry as design space.
+* ``HULL`` forms a convexhull excluding existing objects.
+* Design space is then saved as a ``.stl`` file under the specified ``workspace_path``
+
+\
+
+.. image:: ./initialize.gif
+   :alt: Initialize
+
+Define
+------
+.. figure:: ./def.png
+    :figwidth: 32%
+    :align: right
+
+* Specify the ``number of forces`` acting on the object.
+* Assign materials to face(s) corresponding to each force.
+* Assign vertex groups to edges that depict the direction of each corresponding force.
+* Input the magnitude and click the ``Expand`` button to visualize each one of the aaplied forces.
+
+Generate
+--------
+
+Visualize
+---------

docs/_build/html/installation.html

@@ -36,6 +36,7 @@
 
   <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<img alt="Installation" src="_images/installation.gif" />
 <ul class="simple">
 <li><p>Download the latest release</p></li>
 <li><p>Open Blender and head over to <code class="docutils literal notranslate"><span class="pre">Edit</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Preferences</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Add-ons</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Install</span></code></p></li>
@@ -51,7 +52,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </dd>
 </dl>
 </li>
-<li><p>If you dont have these modules installed, click on <code class="docutils literal notranslate"><span class="pre">Install</span> <span class="pre">required</span> <span class="pre">modules</span></code></p></li>
+<li><p>If you dont have these modules installed, click <code class="docutils literal notranslate"><span class="pre">Install</span> <span class="pre">required</span> <span class="pre">modules</span></code></p></li>
 </ul>
 </div>
 

docs/_build/html/quickstart.html

@@ -36,6 +36,38 @@
 
   <div class="section" id="quickstart">
 <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="initialize">
+<h2>Initialize<a class="headerlink" href="#initialize" title="Permalink to this headline">¶</a></h2>
+<div class="figure align-right" style="width: 32%">
+<img alt="_images/ini.png" src="_images/ini.png" />
+</div>
+<ul class="simple">
+<li><p>Design space can be initialized via two modes.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">SHAPE</span></code> defines existing geometry as design space.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">HULL</span></code> forms a convexhull excluding existing objects.</p></li>
+<li><p>Design space is then saved as a <code class="docutils literal notranslate"><span class="pre">.stl</span></code> file under the specified <code class="docutils literal notranslate"><span class="pre">workspace_path</span></code></p></li>
+</ul>
+<p></p>
+<img alt="Initialize" src="_images/initialize.gif" />
+</div>
+<div class="section" id="define">
+<h2>Define<a class="headerlink" href="#define" title="Permalink to this headline">¶</a></h2>
+<div class="figure align-right" style="width: 32%">
+<img alt="_images/def.png" src="_images/def.png" />
+</div>
+<ul class="simple">
+<li><p>Specify the <code class="docutils literal notranslate"><span class="pre">number</span> <span class="pre">of</span> <span class="pre">forces</span></code> acting on the object.</p></li>
+<li><p>Assign materials to face(s) corresponding to each force.</p></li>
+<li><p>Assign vertex groups to edges that depict the direction of each corresponding force.</p></li>
+<li><p>Input the magnitude and click the <code class="docutils literal notranslate"><span class="pre">Expand</span></code> button to visualize each one of the aaplied forces.</p></li>
+</ul>
+</div>
+<div class="section" id="generate">
+<h2>Generate<a class="headerlink" href="#generate" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="visualize">
+<h2>Visualize<a class="headerlink" href="#visualize" title="Permalink to this headline">¶</a></h2>
+</div>
 </div>
 
 
@@ -57,7 +89,13 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 <h3>Navigation</h3>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#initialize">Initialize</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#define">Define</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#generate">Generate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#visualize">Visualize</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>

docs/installation.rst

@@ -1,6 +1,9 @@
 Installation
 ============
 
+.. image:: ./installation.gif
+   :alt: Installation
+
 * Download the latest release
 * Open Blender and head over to ``Edit`` -> ``Preferences`` -> ``Add-ons`` -> ``Install``
 * Navigate to the downloaded **.zip** file and click ``Install Add-on``

docs/quickstart.rst

@@ -1,2 +1,36 @@
 Quickstart
-==========
+==========
+
+Initialize
+----------
+
+.. figure:: ./ini.png
+    :figwidth: 32%
+    :align: right
+
+* Design space can be initialized via two modes.
+* ``SHAPE`` defines existing geometry as design space.
+* ``HULL`` forms a convexhull excluding existing objects.
+* Design space is then saved as a ``.stl`` file under the specified ``workspace_path``
+
+\
+
+.. image:: ./initialize.gif
+   :alt: Initialize
+
+Define
+------
+.. figure:: ./def.png
+    :figwidth: 32%
+    :align: right
+
+* Specify the ``number of forces`` acting on the object.
+* Assign materials to face(s) corresponding to each force.
+* Assign vertex groups to edges that depict the direction of each corresponding force.
+* Input the magnitude and click the ``Expand`` button to visualize each one of the aaplied forces.
+
+Generate
+--------
+
+Visualize
+---------