diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..499e130 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +dist/index.bundle.js diff --git a/.gitigore b/.gitigore new file mode 100644 index 0000000..5e43aa6 --- /dev/null +++ b/.gitigore @@ -0,0 +1 @@ +dist/index.bundle.js diff --git a/README.md b/README.md index b1b5672..037eedb 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,32 @@ A websperience by Vi Hart, Andrea Hawksley, and Henry Segerman, using the hyperb Try it at: https://hawksley.github.io/hypVR/ + +## Installing Locally + +The version 1.1.0 requires node.js version > 6 and should work with every os. + +### Steps: +- git clone this project +- run "npm install" where you cloned this project +- run "npm start" + +you should see the application run on http://localhost:8080 + Enjoy. + +### Release Notes: +1.1.0: + - The application can be compiled with webpack to reduce dramatically the file size of the imported code + - Less pollution of the global scope + - using webVR polyfill, the application runs on browsers + - the package host it own dev server to compile the code as each file save + - the dev server can be run from an npm command + +### Further Enhancements: +- finishing polishing the code to make it more granular and easy to modify +- introducing performance testing for big functions like gramShmidt +- introducing unit tests + ## Links - http://vihart.com - http://andreahawksley.com @@ -15,3 +41,4 @@ Try it at: https://hawksley.github.io/hypVR/ - http://www.geometrygames.org/CurvedSpaces/ - http://www.marctenbosch.com - https://github.com/MozVR/vr-web-examples/tree/master/threejs-vr-boilerplate +- https://github.com/AbdoulSy diff --git a/CNAME b/dist/CNAME similarity index 100% rename from CNAME rename to dist/CNAME diff --git a/index.html b/dist/index.html similarity index 87% rename from index.html rename to dist/index.html index d0f40a4..9fab9d1 100644 --- a/index.html +++ b/dist/index.html @@ -37,6 +37,19 @@
+ + + + - - - - - - - - - - - - - - - - - + +