Skip to content

Commit

Permalink
Merge pull request #1967 from ExtendRealityLtd/docs/improve-clone-ins…
Browse files Browse the repository at this point in the history
…tructions

docs(README.md): improve cloning the repo instructions
  • Loading branch information
thestonefox committed Mar 30, 2019
2 parents df6d5a1 + bda00db commit f8c9171
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
> A productive toolkit for rapidly building spatial computing solutions in the Unity software.
[![Slack][Slack-Badge]][Slack]
[![Documentation][Academy-Badge]][Academy]
[![Documentation][Academy-Badge]][VRTK.Academy]
[![Videos][Videos-Badge]][Videos]
[![Twitter][Twitter-Badge]][Twitter]
[![Waffle][Waffle-Badge]][Waffle]
Expand All @@ -17,6 +17,10 @@ VRTK aims to make building spatial computing solutions in the [Unity] software f
## Getting Started

### Documentation

Visit the [VRTK.Academy] for a collection of educational content to help you get the most out of building spatial computing solutions with VRTK.

### Setting up the project

* Create a new project in the Unity software version 2018.3 (or above) using 3D Template or open an existing project.
Expand All @@ -35,8 +39,10 @@ VRTK aims to make building spatial computing solutions in the [Unity] software f

* Navigate to the project `Assets/` directory.
* Git clone with required submodules into the `Assets/` directory:
* `git clone --recurse-submodules https://github.com/ExtendRealityLtd/VRTK.git`.
* `git submodule init && git submodule update`.
* `git clone --recurse-submodules https://github.com/ExtendRealityLtd/VRTK.git`
* change to the newly cloned directory: `cd VRTK/`
* `git submodule init && git submodule update`
* The Unity software will now import and compile the new files.

### Running the example scene

Expand Down Expand Up @@ -78,7 +84,7 @@ These materials are not sponsored by or affiliated with Unity Technologies or it
[Waffle-Badge]: https://img.shields.io/badge/project-backlog-78bdf2.svg

[Slack]: http://invite.vrtk.io
[Academy]: https://academy.vrtk.io
[VRTK.Academy]: https://academy.vrtk.io
[Videos]: http://videos.vrtk.io
[Twitter]: https://twitter.com/VR_Toolkit
[Waffle]: http://tracker.vrtk.io

0 comments on commit f8c9171

Please sign in to comment.