Begin adding tutorial docs

Vici37 · Aug 7, 2023 · 313b3ea · 313b3ea
1 parent 5dfb377
commit 313b3ea
Show file tree

Hide file tree

Showing 64 changed files with 8,402 additions and 719 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Crystal Docs 1.8.2">
-<meta name="crystal_docs.project_version" content="master">
+<meta name="crystal_docs.project_version" content="master-dev">
 <meta name="crystal_docs.project_name" content="Crystal Image">
 
 
@@ -14,7 +14,7 @@
 <script type="text/javascript" src="js/doc.js"></script>
 
   <meta name="repository-name" content="Crystal Image">
-  <title>Crystal Image master</title>
+  <title>Crystal Image master-dev</title>
   <script type="text/javascript">
   CrystalDocs.base_path = "";
   </script>
@@ -45,7 +45,7 @@ <h1 class="project-name">
       </h1>
 
       <span class="project-version">
-        master
+        master-dev
       </span>
     </div>
   </div>
@@ -97,6 +97,11 @@ <h1 class="project-name">
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/FftUtil" data-name="crimage::fftutil">
+      <a href="CrImage/FftUtil.html">FftUtil</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/FloatMap" data-name="crimage::floatmap">
       <a href="CrImage/FloatMap.html">FloatMap</a>
 
@@ -172,11 +177,21 @@ <h1 class="project-name">
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/MapImpl" data-name="crimage::mapimpl(t)">
+      <a href="CrImage/MapImpl.html">MapImpl</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/Mask" data-name="crimage::mask">
       <a href="CrImage/Mask.html">Mask</a>
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/NumericMap" data-name="crimage::numericmap(t)">
+      <a href="CrImage/NumericMap.html">NumericMap</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/OneMap" data-name="crimage::onemap">
       <a href="CrImage/OneMap.html">OneMap</a>
 
@@ -310,6 +325,26 @@ <h1 class="project-name">
 </ul>
 
 
+    </li>
+
+  <li class="parent " data-id="Crystal Image/Pluto" data-name="pluto">
+      <a href="Pluto.html">Pluto</a>
+
+        <ul>
+
+  <li class=" " data-id="Crystal Image/Pluto/ImageGA" data-name="pluto::imagega">
+      <a href="Pluto/ImageGA.html">ImageGA</a>
+
+    </li>
+
+  <li class=" " data-id="Crystal Image/Pluto/ImageRGBA" data-name="pluto::imagergba">
+      <a href="Pluto/ImageRGBA.html">ImageRGBA</a>
+
+    </li>
+
+</ul>
+
+
     </li>
 
   <li class="parent " data-id="Crystal Image/StumpyCore" data-name="stumpycore">
@@ -325,6 +360,21 @@ <h1 class="project-name">
 </ul>
 
 
+    </li>
+
+  <li class="parent " data-id="Crystal Image/Tutorial" data-name="tutorial">
+      <a href="Tutorial.html">Tutorial</a>
+
+        <ul>
+
+  <li class=" " data-id="Crystal Image/Tutorial/EdgeDetection" data-name="tutorial::edgedetection">
+      <a href="Tutorial/EdgeDetection.html">EdgeDetection</a>
+
+    </li>
+
+</ul>
+
+
     </li>
 
 </ul>

diff --git a/docs/CrImage.html b/docs/CrImage.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Crystal Docs 1.8.2">
-<meta name="crystal_docs.project_version" content="master">
+<meta name="crystal_docs.project_version" content="master-dev">
 <meta name="crystal_docs.project_name" content="Crystal Image">
 
 
@@ -14,7 +14,7 @@
 <script type="text/javascript" src="js/doc.js"></script>
 
   <meta name="repository-name" content="Crystal Image">
-  <title>CrImage - Crystal Image master</title>
+  <title>CrImage - Crystal Image master-dev</title>
   <script type="text/javascript">
     CrystalDocs.base_path = "";
   </script>
@@ -45,7 +45,7 @@ <h1 class="project-name">
       </h1>
 
       <span class="project-version">
-        master
+        master-dev
       </span>
     </div>
   </div>
@@ -97,6 +97,11 @@ <h1 class="project-name">
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/FftUtil" data-name="crimage::fftutil">
+      <a href="CrImage/FftUtil.html">FftUtil</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/FloatMap" data-name="crimage::floatmap">
       <a href="CrImage/FloatMap.html">FloatMap</a>
 
@@ -172,11 +177,21 @@ <h1 class="project-name">
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/MapImpl" data-name="crimage::mapimpl(t)">
+      <a href="CrImage/MapImpl.html">MapImpl</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/Mask" data-name="crimage::mask">
       <a href="CrImage/Mask.html">Mask</a>
 
     </li>
 
+  <li class=" " data-id="Crystal Image/CrImage/NumericMap" data-name="crimage::numericmap(t)">
+      <a href="CrImage/NumericMap.html">NumericMap</a>
+
+    </li>
+
   <li class=" " data-id="Crystal Image/CrImage/OneMap" data-name="crimage::onemap">
       <a href="CrImage/OneMap.html">OneMap</a>
 
@@ -310,6 +325,26 @@ <h1 class="project-name">
 </ul>
 
 
+    </li>
+
+  <li class="parent " data-id="Crystal Image/Pluto" data-name="pluto">
+      <a href="Pluto.html">Pluto</a>
+
+        <ul>
+
+  <li class=" " data-id="Crystal Image/Pluto/ImageGA" data-name="pluto::imagega">
+      <a href="Pluto/ImageGA.html">ImageGA</a>
+
+    </li>
+
+  <li class=" " data-id="Crystal Image/Pluto/ImageRGBA" data-name="pluto::imagergba">
+      <a href="Pluto/ImageRGBA.html">ImageRGBA</a>
+
+    </li>
+
+</ul>
+
+
     </li>
 
   <li class="parent " data-id="Crystal Image/StumpyCore" data-name="stumpycore">
@@ -325,6 +360,21 @@ <h1 class="project-name">
 </ul>
 
 
+    </li>
+
+  <li class="parent " data-id="Crystal Image/Tutorial" data-name="tutorial">
+      <a href="Tutorial.html">Tutorial</a>
+
+        <ul>
+
+  <li class=" " data-id="Crystal Image/Tutorial/EdgeDetection" data-name="tutorial::edgedetection">
+      <a href="Tutorial/EdgeDetection.html">EdgeDetection</a>
+
+    </li>
+
+</ul>
+
+
     </li>
 
 </ul>
@@ -344,6 +394,17 @@ <h1 class="type-name">
 
 
 
+  <h2>
+    <a id="overview" class="anchor" href="#overview">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Overview
+  </h2>
+
+  <p>This module by itself isn't very interesting. Try taking a look through the <a href="./Tutorial.html">tutorials</a> for better examples.</p>
+
 
 
 
@@ -367,63 +428,77 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/cr-image/edge_policy.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image.cr#L20" target="_blank">
+        cr-image.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image/edge_policy.cr#L1" target="_blank">
         cr-image/edge_policy.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/cr-image/map.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image/map.cr#L1" target="_blank">
         cr-image/map.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/cr-image/operation/bilinear_resize.cr#L14" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image/operation/bilinear_resize.cr#L14" target="_blank">
         cr-image/operation/bilinear_resize.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/cr-image/region.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image/region.cr#L1" target="_blank">
         cr-image/region.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/cr-image/window_view.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/cr-image/window_view.cr#L1" target="_blank">
         cr-image/window_view.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/lib-formats/bindings/lib_jpeg_turbo.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/lib-formats/bindings/lib_jpeg_turbo.cr#L1" target="_blank">
         lib-formats/bindings/lib_jpeg_turbo.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/lib-formats/bindings/lib_spng.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/lib-formats/bindings/lib_spng.cr#L1" target="_blank">
         lib-formats/bindings/lib_spng.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/lib-formats/bindings/lib_webp.cr#L1" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/lib-formats/bindings/lib_webp.cr#L1" target="_blank">
         lib-formats/bindings/lib_webp.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/Vici37/cr-image/blob/59a243fd19b2e83c33ade10364bf46814df81ee3/src/stumpy.cr#L28" target="_blank">
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/pluto.cr#L35" target="_blank">
+        pluto.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/Vici37/cr-image/blob/5dfb37732a70101cfc2e1b9eee6fd01e5bd184f0/src/stumpy.cr#L28" target="_blank">
         stumpy.cr
       </a>