Skip to content

Commit

Permalink
Minor formattin (proposals)
Browse files Browse the repository at this point in the history
  • Loading branch information
kant committed Aug 31, 2018
1 parent 5833fbb commit 8bb5cb3
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/using/quick-guide.md
Expand Up @@ -39,12 +39,12 @@ These documents contain more details on how to use the GitHub for Unity plugin:
### Requirements

- Unity 5.4 or higher
- There's currently an blocker issue opened for 5.3 support, so we know it doesn't run there. Personal edition is fine.
- There's currently a blocker issue opened for 5.3 support, so we know it doesn't run there. 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 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`.

Expand Down Expand Up @@ -73,10 +73,9 @@ Once the extension is installed, you can open a command line with the same Git a
### Installation

This extensions needs to be installed (and updated) for each Unity project that you want to version control.
First step is to download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases);
it will be saved as a file with the extension `.unitypackage`.
First step is to download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases); it will be saved as a file with the extension `.unitypackage`.
To install it, open Unity, then open the project you want to version control, and then double click on the downloaded package.
Alternatively, import the package by clicking Assets, Import Package, Custom Package, then select the downloaded package.
Alternatively, import the package by clicking `Assets`, `Import Package`, `Custom Package`, then select the downloaded package.

#### Log files

Expand All @@ -102,7 +101,7 @@ further.

### Opening the GitHub window

You can access the GitHub window by going to Windows -> GitHub. The window opens by default next to the Inspector window.
You can access the GitHub window by going to `Windows` -> `GitHub`. The window opens by default next to the Inspector window.

### Initialize Repository

Expand Down Expand Up @@ -135,7 +134,7 @@ For more information on Authentication: - **[Authenticating to GitHub](https://g

### Commiting your work - Changes tab

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`
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`

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

Expand All @@ -158,8 +157,8 @@ For more information on working with changes: - **[Working with Changes](https:/

### Settings tab

You can configure your user data in the Settings tab, along with the path to the Git installation.
You can configure your user data in the `Settings` tab, along with the path to the Git installation.

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.

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

0 comments on commit 8bb5cb3

Please sign in to comment.