docs(examples): update readme, add pkg meta/screenshots

technologyarts · Mar 1, 2020 · c75f18c · c75f18c
1 parent f4972a5
commit c75f18c
Show file tree

Hide file tree

Showing 19 changed files with 37 additions and 20 deletions.
diff --git a/assets/examples/hdom-canvas-clock.png b/assets/examples/hdom-canvas-clock.png
diff --git a/assets/examples/hdom-canvas-draw.jpg b/assets/examples/hdom-canvas-draw.jpg
diff --git a/assets/examples/poly-spline.png b/assets/examples/poly-spline.png
diff --git a/assets/examples/rstream-spreadsheet.png b/assets/examples/rstream-spreadsheet.png
diff --git a/assets/examples/shader-ast-sdf2d.jpg b/assets/examples/shader-ast-sdf2d.jpg
diff --git a/assets/examples/webgl-cubemap.jpg b/assets/examples/webgl-cubemap.jpg
diff --git a/assets/examples/webgl-shadertoy.jpg b/assets/examples/webgl-shadertoy.jpg
diff --git a/assets/examples/wolfram.png b/assets/examples/wolfram.png
diff --git a/examples/README.md b/examples/README.md
@@ -29,8 +29,8 @@ in touch via PR, issue tracker, email or twitter!
 | 017 |                                                                               | [hdom-basics](./hdom-basics/)                     | Minimal hdom usage example                                                       |
 | 018 |                                                                               | [hdom-benchmark](./hdom-benchmark/)               | hdom update performance benchmark (old version)                                  |
 | 019 | <img src="../assets/examples/hdom-benchmark2.png" width="240"/>               | [hdom-benchmark2](./hdom-benchmark2/)             | hdom update performance benchmark w/ config options                              |
-| 020 |                                                                               | [hdom-canvas-clock](./hdom-canvas-clock/)         | Realtime analog clock demo                                                       |
-| 021 |                                                                               | [hdom-canvas-draw](./hdom-canvas-draw/)           | Interactive pattern drawing demo using transducers                               |
+| 020 | <img src="../assets/examples/hdom-canvas-clock.png" width="240"/>             | [hdom-canvas-clock](./hdom-canvas-clock/)         | Realtime analog clock demo                                                       |
+| 021 | <img src="../assets/examples/hdom-canvas-draw.jpg" width="240"/>              | [hdom-canvas-draw](./hdom-canvas-draw/)           | Interactive pattern drawing demo using transducers                               |
 | 022 | <img src="../assets/examples/hdom-canvas-particles.jpg" width="240"/>         | [hdom-canvas-particles](./hdom-canvas-particles/) | 2D Bezier curve-guided particle system                                           |
 | 023 | <img src="../assets/hdom-canvas/hdom-canvas-shapes-results.png" width="240"/> | [hdom-canvas-shapes](./hdom-canvas-shapes/)       | Various hdom-canvas shape drawing examples & SVG conversion / export             |
 | 024 |                                                                               | [hdom-dropdown](./hdom-dropdown/)                 | Custom dropdown UI component for hdom                                            |
@@ -58,7 +58,7 @@ in touch via PR, issue tracker, email or twitter!
 | 046 | <img src="../assets/examples/package-stats.png" width="240"/>                 | [package-stats](./package-stats/)                 | CLI util to visualize umbrella pkg stats                                         |
 | 047 | <img src="../assets/pixel/pixel-basics.png" width="240"/>                     | [pixel-basics](./pixel-basics/)                   | Pixel buffer manipulations                                                       |
 | 048 | <img src="../assets/examples/pointfree-svg.png" width="240"/>                 | [pointfree-svg](./pointfree-svg/)                 | Generate SVG using pointfree DSL                                                 |
-| 049 |                                                                               | [poly-spline](./poly-spline/)                     | Polygon to cubic curve conversion & visualization                                |
+| 049 | <img src="../assets/examples/poly-spline.png" width="240"/>                   | [poly-spline](./poly-spline/)                     | Polygon to cubic curve conversion & visualization                                |
 | 050 | <img src="../assets/porter-duff/porter-duff2.png" width="240"/>               | [porter-duff](./porter-duff/)                     | Port-Duff image compositing / alpha blending                                     |
 | 051 | <img src="../assets/examples/ramp-synth.png" width="240"/>                    | [ramp-synth](./ramp-synth/)                       | Unison wavetable synth with waveform editor                                      |
 | 052 | <img src="../assets/examples/rotating-voronoi.jpg" width="240"/>              | [rotating-voronoi](./rotating-voronoi/)           | Animated Voronoi diagram, cubic splines & SVG download                           |
@@ -67,14 +67,14 @@ in touch via PR, issue tracker, email or twitter!
 | 055 | <img src="../assets/examples/rstream-event-loop.png" width="240"/>            | [rstream-event-loop](./rstream-event-loop/)       | Minimal demo of using rstream constructs to form an interceptor-style event loop |
 | 056 | <img src="../assets/examples/rstream-grid.jpg" width="240"/>                  | [rstream-grid](./rstream-grid/)                   | Interactive grid generator, SVG generation & export, undo/redo support           |
 | 057 |                                                                               | [rstream-hdom](./rstream-hdom/)                   | rstream based UI updates & state handling                                        |
-| 058 |                                                                               | [rstream-spreadsheet](./rstream-spreadsheet/)     | rstream based spreadsheet w/ S-expression formula DSL                            |
+| 058 | <img src="../assets/examples/rstream-spreadsheet.png" width="240"/>           | [rstream-spreadsheet](./rstream-spreadsheet/)     | rstream based spreadsheet w/ S-expression formula DSL                            |
 | 059 | <img src="../assets/examples/scenegraph.png" width="240"/>                    | [scenegraph](./scenegraph/)                       | 2D scenegraph & shape picking                                                    |
 | 060 | <img src="../assets/examples/scenegraph-image.png" width="240"/>              | [scenegraph-image](./scenegraph-image/)           | 2D scenegraph & image map based geometry manipulation                            |
 | 061 | <img src="../assets/shader-ast/shader-ast-01.jpg" width="240"/>               | [shader-ast-canvas2d](./shader-ast-canvas2d/)     | 2D canvas shader emulation                                                       |
 | 062 | <img src="../assets/examples/shader-ast-evo.jpg" width="240"/>                | [shader-ast-evo](./shader-ast-evo/)               | Evolutionary shader generation using genetic programming                         |
 | 063 |                                                                               | [shader-ast-noise](./shader-ast-noise/)           | HOF shader procedural noise function composition                                 |
 | 064 | <img src="../assets/shader-ast/shader-ast-raymarch.jpg" width="240"/>         | [shader-ast-raymarch](./shader-ast-raymarch/)     | WebGL & JS canvas2D raymarch shader cross-compilation                            |
-| 065 |                                                                               | [shader-ast-sdf2](./shader-ast-sdf2/)             | WebGL & JS canvas 2D SDF                                                         |
+| 065 | <img src="../assets/examples/shader-ast-sdf2d.jpg" width="240"/>              | [shader-ast-sdf2d](./shader-ast-sdf2d/)           | WebGL & JS canvas 2D SDF                                                         |
 | 066 |                                                                               | [shader-ast-tunnel](./shader-ast-tunnel/)         | WebGL & Canvas2D textured tunnel shader                                          |
 | 067 | <img src="../assets/examples/shader-ast-workers.jpg" width="240"/>            | [shader-ast-workers](./shader-ast-workers/)       | Fork-join worker-based raymarch renderer                                         |
 | 068 | <img src="../assets/examples/soa-ecs-100k.png" width="240"/>                  | [soa-ecs](./soa-ecs/)                             | Entity Component System w/ 100k 3D particles                                     |
@@ -87,11 +87,11 @@ in touch via PR, issue tracker, email or twitter!
 | 075 |                                                                               | [transducers-hdom](./transducers-hdom/)           | Transducer & rstream based hdom UI updates                                       |
 | 076 |                                                                               | [triple-query](./triple-query/)                   | Triple store query results & sortable table                                      |
 | 077 |                                                                               | [webgl-cube](./webgl-cube/)                       | WebGL multi-colored cube mesh                                                    |
-| 078 |                                                                               | [webgl-cubemap](./webgl-cubemap/)                 | WebGL cube maps with async texture loading                                       |
+| 078 | <img src="../assets/examples/webgl-cubemap.jpg" width="240"/>                 | [webgl-cubemap](./webgl-cubemap/)                 | WebGL cube maps with async texture loading                                       |
 | 079 | <img src="../assets/examples/webgl-grid.jpg" width="240"/>                    | [webgl-grid](./webgl-grid/)                       | WebGL instancing, animated grid                                                  |
 | 080 | <img src="../assets/examples/webgl-msdf.jpg" width="240"/>                    | [webgl-msdf](./webgl-msdf/)                       | WebGL MSDF text rendering & particle system                                      |
 | 081 |                                                                               | [webgl-multipass](./webgl-multipass/)             | Minimal multi-pass / GPGPU example                                               |
-| 082 |                                                                               | [webgl-shadertoy](./webgl-shadertoy/)             | Shadertoy-like WebGL setup                                                       |
+| 082 | <img src="../assets/examples/webgl-shadertoy.jpg" width="240"/>               | [webgl-shadertoy](./webgl-shadertoy/)             | Shadertoy-like WebGL setup                                                       |
 | 083 | <img src="../assets/examples/webgl-ssao.jpg" width="240"/>                    | [webgl-ssao](./webgl-ssao/)                       | WebGL screenspace ambient occlusion                                              |
-| 084 |                                                                               | [wolfram](./wolfram/)                             | 1D Wolfram automata with OBJ point cloud export                                  |
-| 085 |                                                                               | [xml-converter](./xml-converter/)                 | XML/HTML/SVG to hiccup/JS conversion                                             |
+| 084 | <img src="../assets/examples/wolfram.png" width="240"/>                       | [wolfram](./wolfram/)                             | 1D Wolfram automata with OBJ point cloud export                                  |
+| 085 | <img src="../assets/examples/xml-converter.png" width="240"/>                 | [xml-converter](./xml-converter/)                 | XML/HTML/SVG to hiccup/JS conversion                                             |
diff --git a/examples/hdom-canvas-clock/package.json b/examples/hdom-canvas-clock/package.json
@@ -33,6 +33,7 @@
             "hdom",
             "hdom-canvas",
             "vectors"
-        ]
+        ],
+        "screenshot": "examples/hdom-canvas-clock.png"
     }
 }
diff --git a/examples/hdom-canvas-draw/package.json b/examples/hdom-canvas-draw/package.json
@@ -31,6 +31,7 @@
         "process": false
     },
     "thi.ng": {
-        "readme": true
+        "readme": true,
+        "screenshot": "examples/hdom-canvas-draw.jpg"
     }
 }
diff --git a/examples/poly-spline/package.json b/examples/poly-spline/package.json
@@ -37,6 +37,7 @@
             "geom-splines",
             "hiccup-svg",
             "transducers-hdom"
-        ]
+        ],
+        "screenshot": "examples/poly-spline.png"
     }
 }
diff --git a/examples/rstream-spreadsheet/package.json b/examples/rstream-spreadsheet/package.json
@@ -50,6 +50,7 @@
             "sexpr",
             "strings",
             "transducers-hdom"
-        ]
+        ],
+        "screenshot": "examples/rstream-spreadsheet.png"
     }
 }
diff --git a/examples/shader-ast-sdf2d/README.md b/examples/shader-ast-sdf2d/README.md
@@ -1,7 +1,7 @@
 # shader-ast-sdf2
 
-- [Live demo (WebGL)](http://demo.thi.ng/umbrella/shader-ast-raymarch/)
-- [Live demo (Canvas 2D)](http://demo.thi.ng/umbrella/shader-ast-raymarch/#2d)
+- [Live demo (WebGL)](http://demo.thi.ng/umbrella/shader-ast-sdf2d/)
+- [Live demo (Canvas 2D)](http://demo.thi.ng/umbrella/shader-ast-sdf2d/#2d)
 
 Basic 3D raymarch shader defined via higher-order constructs of
 [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast)

diff --git a/examples/shader-ast-sdf2d/package.json b/examples/shader-ast-sdf2d/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "shader-ast-sdf2",
+    "name": "shader-ast-sdf2d",
     "description": "WebGL & JS canvas 2D SDF",
     "version": "0.0.1",
     "repository": "https://github.com/thi-ng/umbrella",
@@ -30,6 +30,7 @@
         "process": false
     },
     "thi.ng": {
-        "readme": true
+        "readme": true,
+        "screenshot": "examples/shader-ast-sdf2d.jpg"
     }
 }
diff --git a/examples/webgl-cubemap/package.json b/examples/webgl-cubemap/package.json
@@ -37,6 +37,7 @@
             "matrices",
             "shader-ast",
             "webgl"
-        ]
+        ],
+        "screenshot": "examples/webgl-cubemap.jpg"
     }
 }
diff --git a/examples/webgl-shadertoy/package.json b/examples/webgl-shadertoy/package.json
@@ -29,6 +29,7 @@
         "process": false
     },
     "thi.ng": {
-        "readme": true
+        "readme": true,
+        "screenshot": "examples/webgl-shadertoy.jpg"
     }
 }
diff --git a/examples/wolfram/package.json b/examples/wolfram/package.json
@@ -36,6 +36,7 @@
             "dl-asset",
             "transducers",
             "transducers-binary"
-        ]
+        ],
+        "screenshot": "examples/wolfram.png"
     }
 }
diff --git a/examples/xml-converter/package.json b/examples/xml-converter/package.json
@@ -32,5 +32,14 @@
     ],
     "browser": {
         "process": false
+    },
+    "thi.ng": {
+        "readme": [
+            "defmulti",
+            "sax",
+            "strings",
+            "transducers"
+        ],
+        "screenshot": "examples/xml-converter.png"
     }
 }