Skip to content
This repository was archived by the owner on Oct 20, 2021. It is now read-only.

Commit d33d1d6

Browse files
authored
Merge pull request #1 from spatialos/update-readme-gdk-note
Update README to say GDK should be placed side-by-side
2 parents ff32a4f + 4d42ad0 commit d33d1d6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,28 @@
22

33
This is a blank project that you can use to build your own game with the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity).
44

5+
To use the blank project, you need to lone the GDK for Unity repository alongside the Blank Project so that they sit side-by-side:
6+
7+
```
8+
<common_parent_directory>
9+
├── gdk-for-unity-blank-project
10+
├── gdk-for-unity
11+
```
12+
13+
You can use scripts to automatically do this or follow manual instructions.
14+
15+
##### Automatic set up
16+
From the root of the `gdk-for-unity-blank-project` repository:
17+
18+
* If you are using Windows run: `powershell scripts/powershell/setup.ps1`
19+
* If you are using Mac run: `bash scripts/shell/setup.sh`
20+
21+
##### Manual set up
22+
1. Clone the [GDK for Unity](https://github.com/spatialos/gdk-for-unity) repository alongside the Blank Project so that they sit side-by-side:
23+
* SSH - `git clone [email protected]:spatialos/gdk-for-unity.git`
24+
* HTTPS - `git clone https://github.com/spatialos/gdk-for-unity.git`
25+
2. Navigate to the `gdk-for-unity` directory and checkout the pinned version which you can find in the `gdk.pinned` file, in the root of the `gdk-for-unity-blank-project` directory.
26+
27+
* `git checkout <pinned_version>`
28+
529
&copy; 2018 Improbable

0 commit comments

Comments
 (0)