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

Commit 4cce4fb

Browse files
Merge branch 'master' into fixes/2018-support
2 parents dd5b3d3 + 68091cc commit 4cce4fb

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

docs/using/getting-started.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ And you should see the GitHub spinner:
1919
- History: A history of commits with title, time stamp, and commit author
2020
- Branches: A list of local and remote branches with the ability to create new branches, switch branches, or checkout remote branches
2121
- Settings: your git configuration (pulled from your local git credentials if they have been previously set), your repository configuration (you can manually put the URL to any remote repository here instead of using the Publish button to publish to GitHub), a list of locked files, your git installation details, and general settings to help us better help you if you get stuck
22-
4. You can
2322

24-
# Connecting to an Existing Repository
25-
26-
# Connecting to an Existing Repository that already has the GitHub for Unity package
23+
# Cloning an Existing Repository
24+
GitHub for Unity does not have the functionality to clone projects (yet!).
25+
1. Clone the repository (either through command line or with GitHub Desktop https://desktop.github.com/).
26+
2. Open the project in Unity.
27+
3. Install GitHub for Unity if it is not already installed.
28+
4. The GitHub plugin should load with all functionality enabled.

docs/using/how-to-install-and-update.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,9 @@ Once you've downloaded the package file, you can quickly install it within Unity
4343
<img width="1069" alt="screen shot 2018-05-18 at 7 13 34 am" src="https://user-images.githubusercontent.com/1314285/40239682-9344314c-5a6b-11e8-961f-2293434aa1ea.png">
4444

4545
# Updating the GitHub for Unity Package
46-
_COMING SOON_
46+
47+
- If you are running Unity and wish to update GitHub for Unity (unless explicitly stated), be sure that the files in `x64` and `x86` are not selected.
48+
49+
![image](https://user-images.githubusercontent.com/417571/44666907-6e6d5a80-a9e7-11e8-8f97-b3b52250a75d.png)
50+
51+
- Otherwise, it's best to stop Unity and delete GitHub for Unity from your project. Startup Unity and run the package installer like normal. Allowing it to restore everything.

docs/using/quick-guide.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
These documents contain more details on how to use the GitHub for Unity plugin:
66
- **[Installing and Updating the GitHub for Unity package](https://github.com/github-for-unity/Unity/blob/master/docs/using/how-to-install-and-update.md)**
77
- **[Getting Started with the GitHub for Unity package](https://github.com/github-for-unity/Unity/blob/master/docs/using/getting-started.md)**
8+
- **[Authenticating to GitHub](https://github.com/github-for-unity/Unity/blob/master/docs/using/authenticating-to-github.md)**
9+
- **[Managing Branches](https://github.com/github-for-unity/Unity/blob/master/docs/using/managing-branches.md)**
10+
- **[Locking Files](https://github.com/github-for-unity/Unity/blob/master/docs/using/locking-files.md)**
11+
- **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md)**
812

913
## Table of Contents
1014

@@ -118,6 +122,8 @@ To set up credentials in Git so you can push and pull, you can sign in to GitHub
118122

119123
![Authentication screenshot](https://user-images.githubusercontent.com/121322/27644895-8f22f904-5bd9-11e7-8a93-e6bfe0c24a74.png)
120124

125+
For more information on Authentication: - **[Authenticating to GitHub](https://github.com/github-for-unity/Unity/blob/master/docs/using/authenticating-to-github.md)**
126+
121127
### Publish a new repository
122128

123129
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.
@@ -132,6 +138,8 @@ You can see which files have been changed and commit them through the Changes ta
132138

133139
![Changes tab screenshot](https://user-images.githubusercontent.com/121322/27644933-ab00af72-5bd9-11e7-84c3-edec495f87f5.png)
134140

141+
For more information on working with changes: - **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md#commit-changes)**
142+
135143
### Pushing/pulling your work - History tab
136144

137145
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.
@@ -140,6 +148,9 @@ To receive updates from the server by clicking on the `Pull` button. You cannot
140148

141149
![History tab screenshot](https://user-images.githubusercontent.com/121322/27644965-c1109bba-5bd9-11e7-9257-4fa38f5c67d1.png)
142150

151+
152+
For more information on working with changes: - **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md#pulling-changes)**
153+
143154
### Branches tab
144155

145156
![Branches tab screenshot](https://user-images.githubusercontent.com/121322/27644978-cd3c5622-5bd9-11e7-9dcb-6ae5d5c7dc8a.png)
@@ -150,4 +161,4 @@ You can configure your user data in the Settings tab, along with the path to the
150161

151162
Locked files will appear in a list in the Settings tab. You can see who has locked a file and release file locks after you've pushed your work.
152163

153-
![Settings tab screenshot](https://user-images.githubusercontent.com/121322/27644993-d9d325a0-5bd9-11e7-86f5-beee00e9e8b8.png)
164+
![Settings tab screenshot](https://user-images.githubusercontent.com/121322/27644993-d9d325a0-5bd9-11e7-86f5-beee00e9e8b8.png)

docs/using/working-with-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Working with changes
22

3-
## Commit changes to GitHub
3+
## Commit changes
44

55
All changes made to a repository will show up under the **Changes** view.
66

0 commit comments

Comments
 (0)