how-to-install-and-update.md

Installation and Updating Guide

Installing from a Downloaded Package File
Installing from the Unity Asset Store
Updating a Previously Installed Version

Note: If your Unity project already has the GitHub for Unity plugin installed, see our Getting Started docs before continuing

Installing from a Package File

You can download the latest release from the repository at https://github.com/github-for-unity/Unity/releases or from the website at https://unity.github.com/.

Once you've downloaded the package file, you can quickly install it within Unity.

1. Open a new Unity Project

2. Go to `Assets -> Import Package -> Custom Package`

3. Find and open the GitHub for Unity Asset Package

4. Click `Import` when the dialog pops up

5. After the package finishes importing, go to `Window -> GitHub` to open the GitHub window

6. You should see the GitHub window in your Unity project, with a button to initialize your repository

Installing from the Asset Store

1. Open a new Unity Project

2. Go to `Window -> Asset Store`

3. Search for "GitHub" in the search bar

4. Click on the GitHub for Unity Package

5. Click `Download` then `Install`

6. Click `Import` when the dialog pops up

7. After the package finishes importing, go to `Window -> GitHub` to open the GitHub window

8. You should see the GitHub window in your Unity project, with a button to initialize your repository

Updating the GitHub for Unity Package

• 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.

  

• 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.