chore: update readme with screenshots

balataca · Apr 6, 2020 · b2566d6 · b2566d6
1 parent 1447faa
commit b2566d6
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -7,8 +7,33 @@ This project implements a laser pointer for oculus go and gearVR headsets.
 ### Importing Unity Project
 1. Just add this project to Unity Hub
 
-### Add to an existing Unity Project
-1. Install the Oculus Integration Package from Unity Asset Store
-2. Import the Unity Asset Package located on Releases
-3. Drag the example scene from Assets/Examples/Scenes/PointerExample.unity
-4. Build and Run on your device
+### Creating a new Unity Project
+1. To create a unity VR project, first check out this [Oculus Unity Getting Started Guide](https://developer.oculus.com/documentation/unity/book-unity-gsg/)
+
+
+### Adding Pointer to Unity VR Project
+1. Install the Oculus Android Package from the package manager
+
+![Install oculus android screenshot](ReadmeFiles/1.png)
+
+2. Import at least the VR folder from the Oculus Integration Package from Unity Asset Store
+
+![Import oculus screenshot](ReadmeFiles/2.png)
+
+3. Import our custom Asset Package
+
+![Import custom asset package screenshot](ReadmeFiles/3.png)
+
+4. Import the Unity Asset Package `oculus-laser-pointer.unitypackage` located on Releases.
+
+![Import laser pointer package screenshot](ReadmeFiles/4.png)
+
+## Usage
+
+1. Drag the example scene from Assets/Examples/Scenes/PointerExample.unity
+
+![Open the example scene screenshot](ReadmeFiles/5.png)
+
+2. Build and Run on your device
+
+![Build and run screenshot](ReadmeFiles/6.png)
diff --git a/ReadmeFiles/1.png b/ReadmeFiles/1.png
diff --git a/ReadmeFiles/2.png b/ReadmeFiles/2.png
diff --git a/ReadmeFiles/3.png b/ReadmeFiles/3.png
diff --git a/ReadmeFiles/4.png b/ReadmeFiles/4.png
diff --git a/ReadmeFiles/5.png b/ReadmeFiles/5.png
diff --git a/ReadmeFiles/6.png b/ReadmeFiles/6.png