Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added screenshot
  • Loading branch information
ChristopherMCollins authored Mar 31, 2021
1 parent 3f19dc4 commit 06580c5
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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)

0 comments on commit 06580c5

Please sign in to comment.