|
1 | 1 | # GitHub for Unity |
2 | 2 |
|
3 | | -[](https://githubber.tv/shana/gdc-2017-how-github-works-with-unity) |
| 3 | +The GitHub for Unity extension brings Git and GitHub into Unity, integrating source control into your work with friendly and accessible tools and workflows. |
4 | 4 |
|
5 | | -## How to package a new release |
6 | | - |
7 | | -The OSX build will include mono symbols, so it's better to do it there than on Windows. |
8 | | - |
9 | | -### OSX |
10 | | - |
11 | | -- run `./package.sh` |
12 | | -- The package will be created in unity/PackageProject |
13 | | - |
14 | | -### Windows |
15 | | - |
16 | | -- Do a release build |
17 | | -- Switch to the "Publish" configuration and build |
18 | | -- Open a command prompt and run `package.cmd [path to Unity.exe]` |
19 | | -- The package will be created in unity\PackageProject |
20 | | - |
21 | | -## How to install |
22 | | - |
23 | | -### Requirements |
24 | | - |
25 | | -- [Unity 5.4 or higher](https://store.unity.com/download). Personal edition is fine. |
26 | | - |
27 | | -### Installation |
28 | | - |
29 | | -- Create a new Unity project. |
30 | | -- Download the latest release from the [releases page](https://github.com/github/UnityInternal/releases) and double-click the unitypackage file. The package will install itself into the project currently opened in Unity, and Unity will automatically load it once all the files are in the project. |
31 | | - |
32 | | -For actually seeing things working, you'll need to initialize the directory where you created the Unity project manually with git. Open a command line, head to that directory, and do `git init`. |
33 | | - |
34 | | -### Where is the UI |
35 | | - |
36 | | -Go to the "Window" top level menu and select "GitHub". |
37 | | - |
38 | | -### Known issues |
39 | | - |
40 | | -- Authentication is not plugged in to git yet, so push/pull doesn't work |
41 | | -- lfs locking is not plugged in yet |
42 | | -- Branches list sometimes doesn't show all branches |
43 | | -- Settings view is under construction |
44 | | -- Resizing the history view into wide-mode isn't working right |
45 | | -- Scrolling the changes view hides UI elements that should be always visible (the commit box, the top bar) |
46 | | -- Initializing the project as a git repo is not plugged in yet |
47 | | - |
48 | | -### Copyright |
49 | | -Copyright 2015 - 2017 GitHub, Inc. |
50 | | - |
51 | | -Licensed under the MIT License |
52 | | - |
53 | | -The MIT license grant is not for GitHub's trademarks, which include the logo designs. GitHub reserves all trademark and copyright rights in and to all GitHub trademarks. GitHub's logos include, for instance, the stylized Invertocat designs that include "logo" in the file title in the following folder: https://github.com/github/UnityInternal/tree/master/src/UnityExtension/Assets/Editor/GitHub.Unity/IconsAndLogos. |
54 | | - |
55 | | -GitHub® and its stylized versions and the Invertocat mark are GitHub's Trademarks or registered Trademarks. When using GitHub's logos, be sure to follow the GitHub logo guidelines. |
| 5 | +[Install](docs/install.md) |
| 6 | +[Features](docs/features.md) |
| 7 | +[Known Issues](docs/known-issues.md) |
| 8 | +[Contributing](docs/contributing/install.md) |
0 commit comments