<commit_before># [GitHub for Unity](https://unity.github.com)

## Notices

From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running. Also, remember to update your `.gitignore` file.

![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true)

[![Join the chat at https://gitter.im/github-for-unity/Unity](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github-for-unity/Unity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join the chat at https://discord.gg/5zH8hVx](https://img.shields.io/badge/discord-join%20chat-7289DA.svg)](https://discord.gg/5zH8hVx)
[![GitHub for Unity live coding on Twitch](https://img.shields.io/badge/twitch-live%20coding-6441A4.svg)](https://www.twitch.tv/sh4na)

## About

The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub into [Unity](https://unity3d.com/), integrating source control into your work with friendly and accessible tools and workflows.

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

#### Table Of Contents

[Installing GitHub for Unity](#installing-github-for-unity)
  * [Requirements](#requirements)
     * [Git on macOS](#git-on-macos)
     * [Git on Windows](#git-on-windows)
  * [Installation](#installation)
  * [Log files](#log-files)
     * [Windows](#windows)
     * [macOS](#macos)

[Building and Contributing](#building-and-contributing)

[Quick Guide to GitHub for Unity](#quick-guide-to-github-for-unity)
  * [Opening the GitHub window](#opening-the-github-window)
  * [Initialize Repository](#initialize-repository)
  * [Authentication](#authentication)
  * [Publish a new repository](#publish-a-new-repository)
  * [Commiting your work - Changes tab](#commiting-your-work---changes-tab)
  * [Pushing/pulling your work - History tab](#pushingpulling-your-work---history-tab)
  * [Branches tab](#branches-tab)
  * [Settings tab](#settings-tab)
  
[More Resources](#more-resources)

[License](#license)

## Installing GitHub for Unity

### Requirements

- Unity 5.4-5.6
   - 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.
- Git and Git LFS 2.x

#### Git on macOS

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.

The easiest way of installing git and git lfs is to install [Homebrew](https://brew.sh/) and then do `brew install git git-lfs`.

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:

```
[user]
  name = <NAME>
  email = Your Email
```

#### Git on Windows

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%\GitHubUnity` when the extension runs for the first time.

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:

```
[user]
  name = <NAME>
  email = Your Email
```
<commit_msg>Updating readme to include 2017.1 as a supported version<commit_after># [GitHub for Unity](https://unity.github.com)

## Notices

From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running. Also, remember to update your `.gitignore` file.

![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true)

[![Join the chat at https://gitter.im/github-for-unity/Unity](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github-for-unity/Unity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join the chat at https://discord.gg/5zH8hVx](https://img.shields.io/badge/discord-join%20chat-7289DA.svg)](https://discord.gg/5zH8hVx)
[![GitHub for Unity live coding on Twitch](https://img.shields.io/badge/twitch-live%20coding-6441A4.svg)](https://www.twitch.tv/sh4na)

## About

The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub into [Unity](https://unity3d.com/), integrating source control into your work with friendly and accessible tools and workflows.

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

#### Table Of Contents

[Installing GitHub for Unity](#installing-github-for-unity)
  * [Requirements](#requirements)
     * [Git on macOS](#git-on-macos)
     * [Git on Windows](#git-on-windows)
  * [Installation](#installation)
  * [Log files](#log-files)
     * [Windows](#windows)
     * [macOS](#macos)

[Building and Contributing](#building-and-contributing)

[Quick Guide to GitHub for Unity](#quick-guide-to-github-for-unity)
  * [Opening the GitHub window](#opening-the-github-window)
  * [Initialize Repository](#initialize-repository)
  * [Authentication](#authentication)
  * [Publish a new repository](#publish-a-new-repository)
  * [Commiting your work - Changes tab](#commiting-your-work---changes-tab)
  * [Pushing/pulling your work - History tab](#pushingpulling-your-work---history-tab)
  * [Branches tab](#branches-tab)
  * [Settings tab](#settings-tab)
  
[More Resources](#more-resources)

[License](#license)

## Installing GitHub for Unity

### Requirements

- Unity 5.4-2017.1
   - We've only tested the extension so far on Unity 5.4 to 2017.1. 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.2, so it may or may not run well on that version. Personal edition is fine.
- Git and Git LFS 2.x

#### Git on macOS

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.

The easiest way of installing git and git lfs is to install [Homebrew](https://brew.sh/) and then do `brew install git git-lfs`.

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:

```
[user]
  name = <NAME>
  email = Your Email
```

#### Git on Windows

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%\GitHubUnity` when the extension runs for the first time.

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:

```
[user]
  name = <NAME>
  email = Your Email
```

{'fraction_non_alphanumeric': 0.12022054416876424, 'fraction_numerical': 0.01222581805106077, 'mean_word_length': 4.45359477124183, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 32, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '995209', 'n_tokens_mistral': 2713, 'n_tokens_neox': 2500, 'n_words': 920}