From cd9f7aa5ef31af6e3c549cbb3a33cd4f9144b94e Mon Sep 17 00:00:00 2001 From: Henning Dieterichs Date: Wed, 23 Sep 2020 12:28:47 +0200 Subject: [PATCH] Updates readme, improves text for how to implement new visualizations. --- visualization-bundle/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/visualization-bundle/README.md b/visualization-bundle/README.md index c566f33..6bb108e 100644 --- a/visualization-bundle/README.md +++ b/visualization-bundle/README.md @@ -82,12 +82,16 @@ You can find a playground that demonstrates all visualizations [here](https://he - Clone this repository. - Run `yarn` in the root folder. - Run `yarn dev` in the `visualization-bundle` folder to start tsc in watch mode. -- Edit [./playground/src/visualization.ts](../playground/src/visualizations.ts) to your needs to improve webpack performance. This is highly recommended. +- Edit [./playground/src/visualization.ts](../playground/src/visualizations.ts) to your needs to improve webpack performance. This is highly recommended, but not required. - Run `yarn dev` in the `playground` folder to start the playground where you can debug your visualization. +Any changes to the source are now reflected in the playground! + ## Implementing New Visualizations First, setup your local development copy. You can use the [`simple-text-visualizer`](./src/visualizers/simple-text-visualizer/index.tsx) as starting point! Just copy the folder, rename the ids and names, export it [here](./src/visualizers/index.ts) and read through all the comments of the simple-text-visualizer! + +Use the "open" button in the playground to debug your new visualization!