You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 5, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+85-61Lines changed: 85 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,97 @@ The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub int
8
8
9
9
**Please note:** this software is currently alpha quality. Please refer to the [list of known issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aissue+is%3Aopen+label%3Abug), and make sure you have backups of your work before trying it out.
10
10
11
+
#### Table Of Contents
12
+
13
+
[Installing GitHub for Unity](#installing-github-for-unity)
14
+
*[Requirements](#requirements)
15
+
*[Installation](#installation)
16
+
17
+
[Building and Contributing](#building-and-contributing)
18
+
19
+
[Log files and Known issues](#log-files-and-known-issues)
20
+
*[Windows](#windows)
21
+
*[macOS](#macos)
22
+
23
+
[Quick Guide to GitHub for Unity](#quick-guide-to-gitHub-for-unity)
24
+
*[Opening the GitHub window](#opening-the-github-window)
25
+
*[Initialize Repository](#initialize-repository)
26
+
*[Authentication](#authentication)
27
+
*[Publish a new repository](#publish-a-new-repository)
28
+
*[Commiting your work - Changes tab](#commiting-your-work---changes-tab)
29
+
*[Pushing/pulling your work - History tab](#pushingpulling-your-work---history-tab)
30
+
*[Branches tab](#branches-tab)
31
+
*[Settings tab](#settings-tab)
32
+
[More Resources](#more-resources)
33
+
[License](#license)
34
+
11
35
## Installing GitHub for Unity
12
36
13
37
### Requirements
14
38
15
-
-[Unity 5.4 - 5.6](https://store.unity.com/download). Personal edition is fine.
39
+
-We've only tested the extension so far on Unity 5.4 to 5.6. There's currently an blocker issue opened for 5.3 support, so we know it doesn't run there. There are some issues for 2017.x, so it may or may not run well on that version. Personal edition is fine.
16
40
17
41
### Installation
18
42
19
43
To install the extension, download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases) and double click on it.
20
44
21
-
#### Opening the GitHub window
45
+
## Building and Contributing
46
+
47
+
The [CONTRIBUTING.md](CONTRIBUTING.md) document will help you get setup and familiar with the source. The [documentation](docs/) folder also contains more resources relevant to the project.
48
+
49
+
Please read the [How to Build](docs/contributing/how-to-build.md) document for sinformation on how to build GitHub for Unity.
50
+
51
+
If you're looking for something to work on, check out the [up-for-grabs](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) label.
52
+
53
+
## Log files and Known issues
54
+
55
+
### Windows
56
+
57
+
The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnityDebug` when the extension runs for the first time.
58
+
59
+
You can open a command line with the same Git and Git LFS version that the extension uses by going to the GitHub -> Command line menu.
60
+
61
+
Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig` file and adding the following section, if it doesn't exist yet:
62
+
63
+
```
64
+
[user]
65
+
name = Your Name
66
+
email = Your Email
67
+
```
68
+
69
+
The extension log file can be found at `%LOCALAPPDATA%\GitHubUnityDebug\github-unity.log`
70
+
71
+
#### macOS
72
+
73
+
The extension log file can be found at `~/.local/share/GitHubUnityDebug/github-unity.log`. This is a temporary location and will be changed in the future.
74
+
75
+
The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the Settings tab on the GitHub window.
76
+
77
+
Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet:
78
+
79
+
```
80
+
[user]
81
+
name = Your Name
82
+
email = Your Email
83
+
```
84
+
85
+
## I have a problem with GitHub for Unity
86
+
87
+
First, please search the [open issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen)
88
+
and [closed issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aclosed)
89
+
to see if your issue hasn't already been reported (it may also be fixed).
90
+
91
+
If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/github-for-unity/Unity/issues/new)
92
+
and fill out the template to provide us with enough information to investigate
93
+
further.
94
+
95
+
## Quick Guide to GitHub for Unity
96
+
97
+
### Opening the GitHub window
22
98
23
99
You can access the GitHub window by going to Windows -> GitHub. The window opens by default next to the Inspector window.
@@ -35,98 +111,46 @@ If the current Unity project is not in a Git repository, the GitHub for Unity ex
35
111
- Configure the project to serialize meta files as text
36
112
- Create an initial commit with the `.gitignore` and `.gitattributes` file.
37
113
38
-
####Authentication
114
+
### Authentication
39
115
40
116
To set up credentials in Git so you can push and pull, you can sign in to GitHub by going to `Window` -> `GitHub` -> `Account` -> `Sign in`. You only have to sign in successfully once, your credentials will remain on the system for all Git operations in Unity and outside of it. If you've already signed in once but the Account dropdown still says `Sign in`, ignore it, it's a bug.
1. Go to [github.com](https://github.com) and create a new empty repository - do not add a license, readme or other files during the creation process.
47
123
2. Copy the **https** URL shown in the creation page
48
124
3. In Unity, go to `Windows` -> `GitHub` -> `Settings` and paste the url into the `Remote` textbox.
49
125
3. Click `Save repository`.
50
126
4. Go to the `History` tab and click `Push`.
51
127
52
-
####Commiting your work - Changes tab
128
+
### Commiting your work - Changes tab
53
129
54
130
You can see which files have been changed and commit them through the Changes tab. `.meta` files will show up in relation to their files on the tree, so you can select a file for comitting and automatically have their `.meta`
The history tab includes a `Push` button to push your work to the server. Make sure you have a remote url configured in the `Settings` tab so that you can push and pull your work.
61
137
62
138
To receive updates from the server by clicking on the `Pull` button. You cannot pull if you have local changes, so commit your changes before pulling.
The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnityDebug` when the extension runs for the first time.
81
-
82
-
You can open a command line with the same Git and Git LFS version that the extension uses by going to the GitHub -> Command line menu.
83
-
84
-
Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig` file and adding the following section, if it doesn't exist yet:
85
-
86
-
```
87
-
[user]
88
-
name = Your Name
89
-
email = Your Email
90
-
```
91
-
92
-
##### Log files
93
-
94
-
The extension log file can be found at `%LOCALAPPDATA%\GitHubUnityDebug\github-unity.log`
95
-
96
-
#### macOS
97
-
98
-
The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the Settings tab on the GitHub window.
99
-
100
-
Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet:
101
-
102
-
```
103
-
[user]
104
-
name = Your Name
105
-
email = Your Email
106
-
```
107
-
108
-
##### Log files
109
-
110
-
The extension log file can be found at `~/.local/share/GitHubUnityDebug/github-unity.log`. This is a temporary location and will be changed in the future.
111
-
112
-
## I have a problem with GitHub for Unity
113
-
114
-
First, please search the [open issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen)
115
-
and [closed issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aclosed)
116
-
to see if your issue hasn't already been reported (it may also be fixed).
117
-
118
-
If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/github-for-unity/Unity/issues/new)
119
-
and fill out the template to provide us with enough information to investigate
120
-
further.
121
-
122
-
## How can I contribute to GitHub for Unity?
123
-
124
-
The [CONTRIBUTING.md](./CONTRIBUTING.md) document will help you get setup and
125
-
familiar with the source. The [documentation](docs/) folder also contains more
126
-
resources relevant to the project.
127
-
128
-
If you're looking for something to work on, check out the [up-for-grabs](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) label.
129
-
130
154
## More Resources
131
155
132
156
See [unity.github.com](https://unity.github.com) for more product-oriented
0 commit comments