Skip to content

Windows Client Overview

smahaffey edited this page Sep 27, 2012 · 2 revisions

Installation

  1. Download the installer from http://windows.github.com
  2. Run the installer.
  3. When prompted enter your username and password for GitHub then click continue
  4. Enter your full name and Email. (Note: The email entered here will be made public if you update the repository) and click Continue.
  5. Initially you should not have local repositories so click skip. GitHub is installed! Head to the next section for an overview of how to use the windows client.

##How to clone a repository(copy a repository to your computer) You will only perform this step once to get a copy of a repository initially. After that you will fetch/pull updates instead of clone.

  1. When you start the application after logging in you should see this: view of the initial screen

  2. Select TabakoffLab and then you will see a list of repositories like this: view of the repositories screen

  3. Click clone for the repository you would like to use. It will download which may take a little time. (Note: By default repositories are downloaded to C:\Users\UserName\Documents\GitHub\RepositoryName or C:\Documents and Settings\UserName\Documents\GitHub\RepositoryName depending on your version of windows. You may change this by clicking on Options and move the default storage directory.) view of the clone button

##Make changes and add files as needed to the cloned repository folder. Open files and use them as you would normally from the cloned folder. Once you make changes and are ready to upload them for everyone to access them proceed to the next section.

##Happy with your changes(commit changes to save current files to your history)

  1. Open GitHub

  2. Select the repository you would like to submit changes to and click the blue arrow on the right.

  3. A list of all the modified files will be displayed. It may look something like this: view of the changed files

  4. Enter a brief comment and more detailed commment about what you changed in the files or what new files you added do.

  5. Include a more detailed description if possible.

view of the comment

Optional:

  • You do not have to include every file. Simply uncheck the box next to each file you want to exclude. You can always submit them separately. In fact it may be easier to trace changes you make if you only submit files related to one specific change and then submit files related to the next change.
  • If you can't remember exactly what you changed in a file or why simply click the arrows at the right and you will see the lines that changed to refresh your memory.

view of the changed code in files

  1. Once you are ready, click commit. You may notice now your screen looks like this:

view of the changed code in files

This shows that you committed the files allowing you to go back to the committed version but these changes are not present on the server. Proceed to the next section to push them to server.

##Want to make the changes available on the server?

  1. When you are back to the screen above. Click on Sync which will upload the not synced commit points to the server. view of the sync button

##View changes from other people

  1. Go back to the screen above by clicking on the blue arrow.
  2. If you see the blue sync button it means there are changes that someone else has submitted. If you hover the mouse over the button you can see how many commits have been made. view of the sync button
  3. Click on the sync button to update your local files with changes others have submitted. view of the sync button

##What happens if two people have changed the same file?

Clone this wiki locally