diff --git a/README.md b/README.md index 8af7b9f..44138d8 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,17 @@ p5.xr is an add-on for [p5.js](https://p5js.org/), a Javascript library that mak p5.xr sketches can be run with [p5's online editor.](https://editor.p5js.org/) All of the existing p5 functionality works, and in addition, p5.xr allows you to: - __Virtual Reality__ - - Run any 2D or 3D p5 sketch in mobile VR with Google Cardboard - - Do the above but with Desktop VR (Vive and Oculus) + - Run any 2D or 3D p5 sketch in VR ( mobile, desktop or standalone device ) - __Augmented Reality__ - - Make sketches that use Augmented Reality with any device that supports ARCore. - - Use marker-based AR on any mobile device Coming Soon - - Set anchors and detects planes in your environment --- Coming Soon - -- __Raycasting__ - - Do some simple raycasting for gaze-based interaction in both AR and VR + - Make sketches that use Augmented Reality with any device that supports immersive AR Session ## Getting Started -1. Use the [the most recent version of p5.js](https://p5js.org/download/) or at least version `1.7.0`. +1. Use the [the most recent version of p5.js](https://p5js.org/download/) 2. Check out the [Device and Browser Support Section](https://stalgiag.github.io/p5.xr/#/quick-start/device-support). 3. Add p5.xr to your project. This can be done most easily by adding the script link to a CDN in the `` of your HTML file underneath the p5 link: ``` - + ``` 4. Change the `createCanvas()` call in your p5 WEBGL sketch to `createVRCanvas()` and put it in `preload()` -or- diff --git a/docs/README.md b/docs/README.md index 3134085..831ff6e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,19 +9,18 @@ p5.xr is an add-on for [p5.js](https://p5js.org/), a Javascript library that mak p5.xr sketches can be run with [p5's online editor.](https://editor.p5js.org/) All of the existing p5 functionality works, and in addition, p5.xr allows you to: - __Virtual Reality__ - - Run any 2D or 3D p5 sketch in mobile VR with Google Cardboard - - Do the above but with Desktop VR (Vive and Oculus) + - Run any 2D or 3D p5 sketch in VR ( mobile, desktop or standalone device ) -- __Augmented Reality__ All AR features are waiting for the AR module spec to be implemented in browsers - - Make sketches that use Augmented Reality with any device that supports ARCore. Coming Soon - - Use marker-based AR on any mobile device Coming Soon - - Set anchors and detects planes in your environment --- Coming Soon - -- __Raycasting__ - - Do some simple raycasting for gaze-based interaction in both AR and VR +- __Augmented Reality__ + - Make sketches that use Augmented Reality with any device that supports immersive AR Session ## Getting Started -1. Make sure that you have [the most recent version of p5.js](https://p5js.org/download/). +1. Use the [the most recent version of p5.js](https://p5js.org/download/) 2. Check out the [Device and Browser Support Section](https://stalgiag.github.io/p5.xr/#/quick-start/device-support). -3. [Try out one of the Examples](https://stalgiag.github.io/p5.xr/#/quick-start/examples)! -4. Check out the [Releases section of the Github repo](https://github.com/stalgiag/p5.xr/releases) if you want to run this locally. +3. Add p5.xr to your project. This can be done most easily by adding the script link to a CDN in the `` of your HTML file underneath the p5 link: + ``` + + + ``` +4. Change the `createCanvas()` call in your p5 WEBGL sketch to `createVRCanvas()` and put it in `preload()` -or- +5. [Try out one of the Examples](https://stalgiag.github.io/p5.xr/#/quick-start/examples)! diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 83cd727..01a5ca0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -2,9 +2,10 @@ - __GENERAL__ - [General Info](README.md) - [Community](general/community.md) + *** - __QUICK START__ - - [Device and Browser Support](quick-start/device-support.md) + - [Device and Browser Support](webxr-test.html) - [Examples](quick-start/examples.md) *** - __REFERENCE__ diff --git a/docs/index.html b/docs/index.html index 0b9f966..b9a4549 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,7 +34,7 @@ + +