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

Commit 20e2172

Browse files
committed
Merge master into fixes/progress
2 parents c14943c + eb5c32e commit 20e2172

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

docs/using/getting-started.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
# Getting Started with GitHub for Unity
22
There are often three states that you might be in when you are setting up your GitHub for Unity package with your Unity project:
3-
[Setting up a brand new repository](#setting-up-a-new-repository): You do not currently have your Unity project in a repository and you want to publish it to one.
4-
[Connecting to an existing respository](#connecting-to-an-existing-repository): Your Unity project is already in a repository, but you do not have the GitHub for Unity package installed within it yet.
5-
[Opening a Unity project that already has the GitHub for Unity package](#connecting-to-an-existing-repository-that-already-has-the-github-for-unity-package): Your Unity project is already in a repository and it already has the GitHub for Unity package and you are trying to setup a new machine.
3+
- [Setting up a brand new repository](#setting-up-a-new-repository): You do not currently have your Unity project in a repository and you want to publish it to one.
4+
- [Connecting to an existing respository](#connecting-to-an-existing-repository): Your Unity project is already in a repository, but you do not have the GitHub for Unity package installed within it yet.
5+
- [Opening a Unity project that already has the GitHub for Unity package](#connecting-to-an-existing-repository-that-already-has-the-github-for-unity-package): Your Unity project is already in a repository and it already has the GitHub for Unity package and you are trying to setup a new machine.
66

77
# Setting up a New Repository
8-
When you
8+
If you have a Unity project (new or existing) that is not yet connected to any remote repository, you can use the GitHub for Unity package to quickly intialize the repository and publish to a repository.
99

10-
# Connecting to an Existing Respository
10+
1. If your Unity project doesn't yet have the GitHub plugin installed, follow [these](https://github.com/github-for-unity/Unity/blob/master/docs/using/how-to-install-and-update.md) instructions for installing it.
11+
2. Click on the `Initialize a git repository for this project` button
12+
<img width="950" alt="screen shot 2018-05-18 at 9 39 13 am" src="https://user-images.githubusercontent.com/1314285/40246918-6d8c9156-5a7f-11e8-8087-6ffad9194969.png">
13+
And you should see the GitHub spinner:
14+
<img width="253" alt="screen shot 2018-05-18 at 9 39 23 am" src="https://user-images.githubusercontent.com/1314285/40246956-906cca56-5a7f-11e8-8f93-9484d2519359.png">
15+
3. The GitHub tab should reload with the following buttons:
16+
- Publish: Publish this repository to GitHub (Creating a new GitHub repository)
17+
- Account: Login to your GitHub account | Logout from your GitHub account or visit your profile on GitHub.com
18+
- Changes: Local changes that are not yet committed, with a dialog to commit those changes
19+
- History: A history of commits with title, time stamp, and commit author
20+
- Branches: A list of local and remote branches with the ability to create new branches, switch branches, or checkout remote branches
21+
- 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
23+
24+
# Connecting to an Existing Repository
1125

1226
# Connecting to an Existing Repository that already has the GitHub for Unity package

0 commit comments

Comments
 (0)