Skip to content

Commit af4e543

Browse files
committed
Updated Getting Started in README.md.
1 parent 3711013 commit af4e543

File tree

1 file changed

+35
-20
lines changed

1 file changed

+35
-20
lines changed

README.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,41 @@ built upon
4040
or newer. We recommend using the `master` branch to build new projects with the
4141
AR Foundation SDK and refer to this branch when necessary.
4242

43+
## Getting started
44+
45+
These samples target
46+
[**Unity 2020.3.6f1**](https://unity3d.com/get-unity/download/archive) and
47+
require
48+
[**AR Foundation 4.2.0-pre.7**](https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/manual/index.html)
49+
or newer,
50+
[ARCore Extensions](https://developers.google.com/ar/develop/unity-arf) **1.24**
51+
or newer. Download `arcore-unity-extensions-1.24.0.tgz` from the ARCore
52+
Extensions for AR Foundation
53+
[releases page on GitHub](https://github.com/google-ar/arcore-unity-extensions/releases).
54+
55+
Choose one of the following approaches to import the ARCore Extensions Package:
56+
57+
1. Manually update dependencies before launching the project:
58+
59+
* Locate `arcore-depth-lab/Packages/manifest.json`.
60+
* Add the dependency of ARCore Extensions SDK with the loca path:
61+
`"com.google.ar.core.arfoundation.extensions":
62+
"file:{path/to}/arcore-unity-extensions-1.24.0.tgz",`
63+
* Launch the project with Unity Editor 2020.3.
64+
65+
2. Use Package Manager to import dependent package:
66+
67+
* Use Unity 2020.3 to open the project.
68+
* It's expected that a window pops up and shows there are compile errors
69+
in this project due to missing Extensions SDK, select **Continue**.
70+
* In Unity editor, navigate to `Window` -> `Package Manager`
71+
* Click the plus button, and choose the `Add package from tarball...`
72+
option from the drop-down menu.
73+
* Locate `arcore-unity-extensions-1.24.0.tgz` and click Open.
74+
75+
This project only builds with the Build Platform **Android**. Build the project
76+
to an Android device instead of using the **Play** button in the Unity editor.
77+
4378
## Sample features
4479

4580
The sample scenes demonstrate three different ways to access depth. Supported
@@ -68,26 +103,6 @@ can be found in the `arcore_unity_sdk` branch.
68103
* Environment relighting
69104
* 3D photo
70105

71-
## Unity project setup
72-
73-
These samples target
74-
[**Unity 2020.3.6f1**](https://unity3d.com/get-unity/download/archive) and
75-
require
76-
[**AR Foundation 4.2.0-pre.7**](https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/manual/index.html)
77-
or newer,
78-
[ARCore Extensions](https://developers.google.com/ar/develop/unity-arf) **1.24**
79-
or newer. Download `arcore-unity-extensions-1.24.0.tgz` from the ARCore
80-
Extensions for AR Foundation
81-
[releases page on GitHub](https://github.com/google-ar/arcore-unity-extensions/releases).
82-
Use Unity 2020.3 to open the project and import the package in `Window` ->
83-
`Package Manager`, click the plus button, and choose the `Add package from
84-
tarball...` option from the drop-down menu. Then locate
85-
`arcore-unity-extensions-1.24.0.tgz` and click Open.
86-
87-
This project only builds with the Build Platform
88-
**Android**. Build the project to an Android device instead of using the
89-
**Play** button in the Unity editor.
90-
91106
## Building samples
92107

93108
Individual scenes can be built and run by enabling a particular scene (e.g.,

0 commit comments

Comments
 (0)