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

Commit c1cb938

Browse files
Updating documents
1 parent 9d64768 commit c1cb938

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/contributing/coding-conventions.md

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

3-
##Coding Conventions
3+
## Coding Conventions
44
- PascalCase for all types regardless of visibility
55
- PascalCase for public members and const members
66
- camelCase for private members, parameters and variables

docs/contributing/how-to-build.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# Contributing to GitHub for Unity
22

3-
## How to Build
3+
## Build Requirements
4+
To build GitHub for Unity we recommend using Visual Studio 2015 or Mono 4.x and bash.
45

6+
## How to Build
7+
58
### Visual Studio
69

10+
To build with Visual Studio 2015 open the solution file `GitHub.Unity.sln`. Select `Build Solution` in the `Build` menu.
11+
712
### Mono and Bash
813

14+
To build with Mono 4.x and Bash execute `build.sh` in a bash shell.
15+
916
## Build Output
17+
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.

0 commit comments

Comments
 (0)