Skip to content
This repository was archived by the owner on Dec 5, 2024. It is now read-only.

Commit 7cfa508

Browse files
Update how-to-build.md
1 parent e55d78d commit 7cfa508

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/contributing/how-to-build.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# Contributing to GitHub for Unity
22

33
## Build Requirements
4-
To build GitHub for Unity we recommend using Visual Studio 2015 or Mono 4.x and bash.
4+
- To build GitHub for Unity we recommend using Visual Studio 2015 or Mono 4.x and bash.
5+
- The build scripts expect to find Unity in it's default installed location
6+
- Windows: `C:\Program Files (x86)\Unity\`
7+
- macOS: `\Applications\Unity\`
8+
- Alternatively `UnityEditor.dll` and `UnityEngine.dll` can be copied to `.\script\lib`
59

610
## How to Build
11+
12+
Clone the repository and its submodules in a git GUI client or via the command line:
13+
14+
```
15+
git clone https://github.com/github-for-unity/Unity
16+
cd Unity
17+
git submodule init
18+
git submodule deinit script
19+
git submodule update
20+
```
721

822
### Visual Studio
923

@@ -15,4 +29,4 @@ To build with Mono 4.x and Bash execute `build.sh` in a bash shell.
1529

1630
## Build Output
1731

18-
Building the project creates an output folder named `github-unity-test` that is a sibling to the cloned repository. For instance, if the solution is located at `c:\Projects\Unity` the test output can be foud at `c:\Projects\github-unity-test`. The output folder contains a blank Unity project folder named `GitHubExtensionProject`. This folder is a blank Unity 5.5 project with GitHub for Unity installed.
32+
Building the project creates an output folder named `github-unity-test` that is a sibling to the cloned repository. For instance, if the solution is located at `c:\Projects\Unity` the test output can be foud at `c:\Projects\github-unity-test`. The output folder contains a blank Unity project folder named `GitHubExtensionProject`. This folder is a blank Unity 5.5 project with GitHub for Unity installed.

0 commit comments

Comments
 (0)