From 06580c5824ba09ee64d9d47e348130740da8b04c Mon Sep 17 00:00:00 2001 From: Christopher Collins Date: Tue, 30 Mar 2021 18:16:51 -0700 Subject: [PATCH] Update README.md added screenshot --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e53b417..6485d86 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ To prepare to run the previewer, open the Dist folder in the terminal and run `` To run the previewer, run ```node .``` in a terminal from the dist folder. This will start the web server on localhost:8080 When you open localhost:8080 in your web browser, the previewer will have the Iris dataset loaded in. -It will display a fully interactable graph as well as the orthographic views for each side of the cube. +It will display a fully interactable 3D scatterplot as well as the orthographic views for each side of the cube (scroll to see them). To add a dataset to the viewer, add the dataset's file into the folder Dist/datasets. Datasets are expected to formatted as comma separated values (csv). @@ -25,3 +25,7 @@ To load the dataset into the viewer, fill out the form at the top of the page. T - The offset from the beginning of each entry which to load the x, y, and z values. None of the offsets should be the same, nor should they be greater than or equal to the dataset's dimension, or unexpected results will occur. These values are 0-indexed. Click the Load button to load the dataset. There is no indicator while the dataset is loading, but there will be an error message if it fails. + +The default view should look like this: + +![ScreenShot](3d-scatterplot-view.PNG)