From 2a205f2449c4def1f74abf24d4366ce05a0e0d1e Mon Sep 17 00:00:00 2001 From: Jordan Santell Date: Tue, 10 Oct 2017 12:16:37 -0700 Subject: [PATCH] Provide links to gh-pages built files in lieu of issues building on Windows for now --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 34507173..1d9a7d18 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,31 @@ Name | Type | Parameter description `volume` | Number | (Optional) The initial volume of the media; it ranges between 0 and 1; zero equals muted. `muted` | Boolean | (Optional) When true, mutes the sound of the video. +# Downloading files + +The `gh-pages` branch hosts the built files. Download these instead of linking to these +locations, since the directory structure of the repo may change in the future. + +* [https://googlevr.github.io/vrview/build/vrview.js](https://googlevr.github.io/vrview/build/vrview.js) +* [https://googlevr.github.io/vrview/build/vrview.min.js](https://googlevr.github.io/vrview/build/vrview.min.js) +* [https://googlevr.github.io/vrview/build/embed.js](https://googlevr.github.io/vrview/build/embed.js) +* [https://googlevr.github.io/vrview/build/embed.min.js](https://googlevr.github.io/vrview/build/embed.min.js) +* [https://googlevr.github.io/vrview/build/three.js](https://googlevr.github.io/vrview/build/three.js) +* [https://googlevr.github.io/vrview/build/three.min.js](https://googlevr.github.io/vrview/build/three.min.js) +* [https://googlevr.github.io/vrview/build/device-motion-sender.min.js](https://googlevr.github.io/vrview/build/device-motion-sender.min.js) + +# Building + +This project uses `browserify` to manage dependencies and build. `watchify` is +especially convenient to preserve the write-and-reload model of development. +This package lives in the npm index. + +**Current builds are not working on Windows ([#261](https://github.com/googlevr/vrview/issues/261))** + +Relevant commands: +```shell +$ npm run build # builds the iframe embed and JS API (full and minified versions). + # Building This project uses `browserify` to manage dependencies and build. `watchify` is