docs: switch/update remaining pkg readmes to generated versions

thi-ng · Nov 28, 2019 · 43a73ee · 43a73ee
1 parent 69f7f18
commit 43a73ee
Show file tree

Hide file tree

Showing 83 changed files with 5,802 additions and 732 deletions.
diff --git a/packages/atom/README.md b/packages/atom/README.md
@@ -94,6 +94,10 @@ Interactive grid generator, SVG generation & export, undo/redo support
 
 [Live demo](https://demo.thi.ng/umbrella/rstream-grid/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-grid)
 
+### rstream-spreadsheet <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-spreadsheet)
+
 ### svg-waveform <!-- NOTOC -->
 
 Additive waveform synthesis & SVG visualization with undo/redo

diff --git a/packages/defmulti/README.md b/packages/defmulti/README.md
@@ -13,6 +13,7 @@ This project is part of the
   - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
   - [defmulti()](#defmulti--)
     - [Dispatch value hierarchies](#dispatch-value-hierarchies)
@@ -47,6 +48,18 @@ yarn add @thi.ng/defmulti
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
 - [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/master/packages/errors)
 
+## Usage examples
+
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/master/examples)
+directory are using this package.
+
+A selection:
+
+### rstream-spreadsheet <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-spreadsheet)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/defmulti/)

diff --git a/packages/dsp/README.md b/packages/dsp/README.md
@@ -56,6 +56,10 @@ A selection:
 
 [Live demo](https://demo.thi.ng/umbrella/poly-spline/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/poly-spline)
 
+### webgl-ssao <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-ssao/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-ssao)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/dsp/)

diff --git a/packages/gp/README.md b/packages/gp/README.md
@@ -11,6 +11,8 @@ This project is part of the
 
 - [About](#about)
   - [Status](#status)
+  - [Related packages](#related-packages)
+  - [Blog posts](#blog-posts)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
@@ -47,6 +49,18 @@ References:
 
 **ALPHA** - bleeding edge / work-in-progress
 
+### Related packages
+
+- [@thi.ng/defmulti](https://github.com/thi-ng/umbrella/tree/develop/packages/defmulti) - Dynamic, extensible multiple dispatch via user supplied dispatch function.
+- [@thi.ng/pointfree](https://github.com/thi-ng/umbrella/tree/develop/packages/pointfree) - Pointfree functional composition / Forth style stack execution engine
+- [@thi.ng/sexpr](https://github.com/thi-ng/umbrella/tree/develop/packages/sexpr) - Extensible S-Expression parser & runtime infrastructure
+- [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast) - DSL to define shader code in TypeScript and cross-compile to GLSL, JS and other targets
+- [@thi.ng/zipper](https://github.com/thi-ng/umbrella/tree/develop/packages/zipper) - Functional tree editing, manipulation & navigation
+
+### Blog posts
+
+- [Evolutionary failures (Part 1)](https://medium.com/@thi.ng/evolutionary-failures-part-1-54522c69be37)
+
 ## Installation
 
 ```bash

diff --git a/packages/gp/package.json b/packages/gp/package.json
@@ -59,7 +59,20 @@
     },
     "sideEffects": false,
     "thi.ng": {
+        "blog": [
+            {
+                "title": "Evolutionary failures (Part 1)",
+                "url": "https://medium.com/@thi.ng/evolutionary-failures-part-1-54522c69be37"
+            }
+        ],
         "branch": "develop",
+        "related": [
+            "defmulti",
+            "pointfree",
+            "sexpr",
+            "shader-ast",
+            "zipper"
+        ],
         "status": "alpha",
         "year": 2019
     }

diff --git a/packages/hdom/README.md b/packages/hdom/README.md
@@ -229,6 +229,16 @@ Interactive grid generator, SVG generation & export, undo/redo support
 
 [Live demo](https://demo.thi.ng/umbrella/rstream-grid/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-grid)
 
+### rstream-spreadsheet <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-spreadsheet)
+
+### soa-ecs <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/soa-ecs-100k.png)
+
+[Live demo](https://demo.thi.ng/umbrella/soa-ecs/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/soa-ecs)
+
 ### svg-waveform <!-- NOTOC -->
 
 Additive waveform synthesis & SVG visualization with undo/redo

diff --git a/packages/hiccup-svg/README.md b/packages/hiccup-svg/README.md
@@ -147,6 +147,12 @@ Basic crypto-currency candle chart with multiple moving averages plots
 
 [Live demo](https://demo.thi.ng/umbrella/hdom-canvas-shapes/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/hdom-canvas-shapes)
 
+### pointfree-svg <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/pointfree-svg.png)
+
+[Live demo](https://demo.thi.ng/umbrella/pointfree-svg/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/pointfree-svg)
+
 ### poly-spline <!-- NOTOC -->
 
 [Live demo](https://demo.thi.ng/umbrella/poly-spline/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/poly-spline)

diff --git a/packages/hiccup/README.md b/packages/hiccup/README.md
@@ -166,6 +166,12 @@ Filterable commit log UI w/ minimal server to provide commit history
 
 [Live demo](https://demo.thi.ng/umbrella/hydrate-basics/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/hydrate-basics)
 
+### pointfree-svg <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/pointfree-svg.png)
+
+[Live demo](https://demo.thi.ng/umbrella/pointfree-svg/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/pointfree-svg)
+
 ### rstream-grid <!-- NOTOC -->
 
 Interactive grid generator, SVG generation & export, undo/redo support

diff --git a/packages/matrices/README.md b/packages/matrices/README.md
@@ -14,6 +14,7 @@ This project is part of the
   - [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
   - [Constants](#constants)
   - [Matrix creation](#matrix-creation)
@@ -71,6 +72,38 @@ yarn add @thi.ng/matrices
 - [@thi.ng/math](https://github.com/thi-ng/umbrella/tree/master/packages/math)
 - [@thi.ng/vectors](https://github.com/thi-ng/umbrella/tree/master/packages/vectors)
 
+## Usage examples
+
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/master/examples)
+directory are using this package.
+
+A selection:
+
+### soa-ecs <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/soa-ecs-100k.png)
+
+[Live demo](https://demo.thi.ng/umbrella/soa-ecs/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/soa-ecs)
+
+### webgl-cube <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-cube/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-cube)
+
+### webgl-cubemap <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-cubemap/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-cubemap)
+
+### webgl-grid <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-grid/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-grid)
+
+### webgl-msdf <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/webgl-msdf.jpg)
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-msdf/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-msdf)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/matrices/)

diff --git a/packages/memoize/README.md b/packages/memoize/README.md
@@ -13,6 +13,7 @@ This project is part of the
   - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
   - [Optimized version for single arg functions](#optimized-version-for-single-arg-functions)
   - [Arbitrary args](#arbitrary-args)
@@ -49,6 +50,18 @@ yarn add @thi.ng/memoize
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
 
+## Usage examples
+
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/master/examples)
+directory are using this package.
+
+A selection:
+
+### rstream-spreadsheet <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-spreadsheet)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/memoize/)

diff --git a/packages/pixel/README.md b/packages/pixel/README.md
@@ -126,6 +126,10 @@ A selection:
 
 [Live demo](https://demo.thi.ng/umbrella/porter-duff/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/porter-duff)
 
+### webgl-multipass <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/webgl-multipass/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/webgl-multipass)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/pixel/)

diff --git a/packages/porter-duff/README.md b/packages/porter-duff/README.md
@@ -50,7 +50,7 @@ ints or RGBA float vectors.
 ### Related packages
 
 - [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/master/packages/pixel) - Typed array backed, packed pixel buffer w/ customizable formats, blitting, conversions
-- [@thi.ng/shader-ast-stdlib](https://github.com/thi-ng/umbrella/tree/master/packages/shader-ast-stdlib) - Useful functions for GPGPU / shader programming w/ [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/master/packages/shader-ast)
+- [@thi.ng/shader-ast-stdlib](https://github.com/thi-ng/umbrella/tree/master/packages/shader-ast-stdlib) - Function collection for modular GPGPU / shader programming with [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/master/packages/shader-ast)
 
 ## Installation
 

diff --git a/packages/rstream-graph/README.md b/packages/rstream-graph/README.md
@@ -74,6 +74,10 @@ Interactive grid generator, SVG generation & export, undo/redo support
 
 [Live demo](https://demo.thi.ng/umbrella/rstream-grid/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-grid)
 
+### rstream-spreadsheet <!-- NOTOC -->
+
+[Live demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/rstream-spreadsheet)
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/rstream-graph/)

diff --git a/packages/sax/README.md b/packages/sax/README.md
@@ -1,3 +1,5 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
 # @thi.ng/sax
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/sax.svg)](https://www.npmjs.com/package/@thi.ng/sax)
@@ -7,6 +9,21 @@
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
 
+- [About](#about)
+  - [Status](#status)
+  - [Related packages](#related-packages)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [API](#api)
+  - [Basic usage](#basic-usage)
+  - [Partial parsing & result post-processing](#partial-parsing---result-post-processing)
+  - [DOM-style tree parsing using `defmulti`](#dom-style-tree-parsing-using--defmulti-)
+  - [Error handling](#error-handling)
+- [Emitted result type IDs](#emitted-result-type-ids)
+- [Parser options](#parser-options)
+- [Authors](#authors)
+- [License](#license)
+
 ## About
 
 [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/master/packages/transducers)-based,
@@ -26,6 +43,16 @@ Additionally, since by default the parser emits any children as part of
 "element end" events, it can be used like a tree-walking DOM parser as
 well (see SVG parsing example further below). The choice is yours!
 
+### Status
+
+**STABLE** - used in production
+
+### Related packages
+
+- [@thi.ng/hiccup-svg](https://github.com/thi-ng/umbrella/tree/master/packages/hiccup-svg) - SVG element functions for [@thi.ng/hiccup](https://github.com/thi-ng/umbrella/tree/master/packages/hiccup) & [@thi.ng/hdom](https://github.com/thi-ng/umbrella/tree/master/packages/hdom)
+- [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/master/packages/transducers) - Lightweight transducer implementations for ES6 / TypeScript
+- [@thi.ng/transducers-fsm](https://github.com/thi-ng/umbrella/tree/master/packages/transducers-fsm) - Transducer-based Finite State Machine transformer
+
 ## Installation
 
 ```bash
@@ -38,7 +65,11 @@ yarn add @thi.ng/sax
 - [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/master/packages/transducers)
 - [@thi.ng/transducers-fsm](https://github.com/thi-ng/umbrella/tree/master/packages/transducers-fsm)
 
-## Usage examples
+## API
+
+[Generated API docs](https://docs.thi.ng/umbrella/sax/)
+
+### Basic usage
 
 ```ts
 import * as sax from "@thi.ng/sax";
@@ -281,8 +312,8 @@ The `type` key in each emitted result object is a TypeScript enum with the follo
 
 ## Authors
 
-- Karsten Schmidt
+Karsten Schmidt
 
 ## License
 
-&copy; 2018 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0