update readme

README.md

@@ -1,44 +1,57 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+#VR-Viz Boilerplate
 
-## Available Scripts
+This git repo provides a boilerplate for creating data visualization in VR using VR-Viz package. 
+
+VR-Viz is react component which combines React.js, D3.js and A-frame to create data visualization in VR.
+
+
+This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
+
+To see the full documentation regarding that, go [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md). The salient points are reproduced below, along with important custom setup documentation.
+
+## Installation using NPM
+This project uses `npm`. Install it as described here [https://docs.npmjs.com/downloading-and-installing-node-js-and-npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you haven't already.
+
+To install this boilerplate, simply clone the repo and run `npm install`;
+
+e.g.
+
+    git clone https://github.com/mustafasaifee42/vr-viz-boilerplate.git
+    cd vr-viz-boilerplate
+    npm install
+
+## Local Development
 
 In the project directory, you can run:
 
-### `npm start`
+### `npm run start`
 
 Runs the app in the development mode.<br>
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
 The page will reload if you make edits.<br>
 You will also see any lint errors in the console.
 
-### `npm test`
-
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
+To view this in your VR headset (if the headset is connected to the same system on which the local development is done) open a browser(prefereablly latest version of chrome, firefox or edge) in the VR environment and open [http://localhost:3000](http://localhost:3000) in it.
 
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
+If the headset is connected to another system than on which the local development is done then using `ipconfig` in CLI get the IPv4 address of the system on which the development is done. Then, open a browser(prefereablly latest version of chrome, firefox or edge) in the VR environment in the headset and open `{ip-address}:3000` in it (replace ip-address with the IPv4 address got using `ipconfig`). Make sure that both the systems are connected to the same wi-fi network.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+In the browser you should be able to see a barchart.
 
-### `npm run eject`
+![BarGraph](./imgs/bargraph.PNG)
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+TO enter the VR mode click the Enter VR Mode icon in the bottom right in the browser.
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+## Editing the Boilerplate
 
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+### Updating the data sheet
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+In the project directory, in public folder edit `data.csv` file with new data to plot that data in VR. You can replace this file in public folder with another `csv`, `json`, `txt`, or `ply` file which has your data.
 
-## Learn More
+* `csv` file can be created in excel or any other software.
+* `txt` file is used for datafiles without headers with values seperated by a comma.
+* `ply` is primarily used for `point cloud` visualization.
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+### Updating the graph
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+In the project directory, in src folder edit `App.js` file. Read the detail documention [here](https://github.com/mustafasaifee42/VR-Viz) how `App.js` can be edited to use a specific visualization and how these visualizations can be edited.