@brownnrl/geomlib 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -3
- package/dist/bundle.js +1 -1
- package/dist/bundle.js.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -19,6 +19,14 @@ The library exposes eight element classes — *point*, *line*, *circle*,
|
|
|
19
19
|
[`tables.html`](geom_applet/source/tables.html). All 465 propositions
|
|
20
20
|
across Books I–XIII of the *Elements* are renderable.
|
|
21
21
|
|
|
22
|
+
On top of the construction layer the library also ships an optional
|
|
23
|
+
slideshow surface — per-element visibility, declarative `slides[]`,
|
|
24
|
+
a caption / justification overlay — and a slide-transition animation
|
|
25
|
+
registry where a circle can sweep in like a compass, a line can trace
|
|
26
|
+
like a straightedge, and a polygon can outline then fade in its fill.
|
|
27
|
+
Both layers are additive and default-off, so diagrams that don't opt
|
|
28
|
+
in render exactly as they always have.
|
|
29
|
+
|
|
22
30
|
## Installation
|
|
23
31
|
|
|
24
32
|
### Via CDN (no build step)
|
|
@@ -84,10 +92,12 @@ example, see [doc/quickstart.md](doc/quickstart.md).
|
|
|
84
92
|
| Doc | Audience |
|
|
85
93
|
|---|---|
|
|
86
94
|
| [doc/quickstart.md](doc/quickstart.md) | First-time user. Builds Proposition I.1 line by line with prose explanations. |
|
|
87
|
-
| [doc/api.md](doc/api.md) | API reference. Every `init()` field, every `E.{Type}.{name}` construction, every accepted color value. |
|
|
88
|
-
| [doc/architecture.md](doc/architecture.md) | Implementation model. The slate, the construction dispatch, the drag pipeline. |
|
|
95
|
+
| [doc/api.md](doc/api.md) | API reference. Every `init()` field, every `E.{Type}.{name}` construction, every `A.{Type}.{name}` animation, every accepted color value. |
|
|
96
|
+
| [doc/architecture.md](doc/architecture.md) | Implementation model. The slate, the construction dispatch, the drag pipeline, the slideshow surface, the animation orchestrator. |
|
|
89
97
|
| [doc/creating-constructions.md](doc/creating-constructions.md) | Adding a new construction type to the library. |
|
|
98
|
+
| [doc/creating-animations.md](doc/creating-animations.md) | Adding a new slide-transition animation. |
|
|
90
99
|
| [doc/constructions-reference.md](doc/constructions-reference.md) | Per-construction priority and usage frequency across Books I–III. |
|
|
100
|
+
| [doc/animations-reference.md](doc/animations-reference.md) | Catalog of every `A.*` animation — defaults, args, visual behaviour. |
|
|
91
101
|
| [doc/historical/](doc/historical/) | Project journal and the Java-to-TypeScript porting record. |
|
|
92
102
|
|
|
93
103
|
## Build, test, develop
|
|
@@ -97,7 +107,7 @@ npm install # install dependencies (once)
|
|
|
97
107
|
npm run build # compile TypeScript (no emit; type-check only)
|
|
98
108
|
npm test # run the full Mocha suite (unit + snapshot)
|
|
99
109
|
npm run test:unit # unit tests only
|
|
100
|
-
npm run test:snapshot #
|
|
110
|
+
npm run test:snapshot # 700 rendered-pixel snapshot tests
|
|
101
111
|
npm run coverage # tests + c8 code coverage report
|
|
102
112
|
npm run bundle # webpack dev-mode bundle to dist/bundle.js
|
|
103
113
|
npm run bundle:prod # webpack production (minified) bundle
|