Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
110 lines
12 KiB
Markdown
110 lines
12 KiB
Markdown
---
|
|
title: Getting started with GitHub Desktop
|
|
intro: 'Learn how to set up, authenticate, and configure {{ site.data.variables.product.prodname_desktop }} to allow you to contribute to projects directly from your machine.'
|
|
miniTocMaxHeadingLevel: 4
|
|
versions:
|
|
free-pro-team: '*'
|
|
---
|
|
|
|
### Introduction
|
|
{{ site.data.variables.product.prodname_desktop }} is an application that enables you to interact with {{ site.data.variables.product.prodname_dotcom }} using a GUI instead of the command line or a web browser. {{ site.data.variables.product.prodname_desktop }} encourages you and your team to collaborate using best practices with Git and {{ site.data.variables.product.prodname_dotcom }}. You can use {{ site.data.variables.product.prodname_desktop }} to complete most Git commands from your desktop with visual confirmation of changes. You can push to, pull from, and clone remote repositories with {{ site.data.variables.product.prodname_desktop }}, and use collaborative tools such as attributing commits and creating pull requests.
|
|
|
|
This guide will help you get started with {{ site.data.variables.product.prodname_desktop }} by setting up the application, authenticating your account, configuring basic settings, and introducing the fundamentals of managing projects with {{ site.data.variables.product.prodname_desktop }}. You will be able to use {{ site.data.variables.product.prodname_desktop }} to collaborate on projects and connect to remote repositories after working through this guide.
|
|
|
|
You might find it helpful to have a basic understanding of Git and {{ site.data.variables.product.prodname_dotcom }} before getting started with {{ site.data.variables.product.prodname_desktop }}. For more information, see the following articles.
|
|
|
|
- "[Learning about Git](/github/using-git/learning-about-git)"
|
|
- "[Learning about {{ site.data.variables.product.prodname_dotcom }}](/github/getting-started-with-github/learning-about-github)"
|
|
- "[Getting started with {{ site.data.variables.product.prodname_dotcom }}](/github/getting-started-with-github)"
|
|
|
|
{{ site.data.variables.product.prodname_desktop }} is an open source project. You can see the roadmap, contribute to the project, or open an issue to provide feedback or feature requests. For more information, see the [`desktop/desktop`](https://github.com/desktop/desktop) repository.
|
|
|
|
### Part 1: Installing and authenticating
|
|
You can install {{ site.data.variables.product.prodname_desktop }} on any supported operating system. For more information, see "[Supported operating systems](/desktop/getting-started-with-github-desktop/supported-operating-systems)."
|
|
|
|
To install {{ site.data.variables.product.prodname_desktop }}, visit the download page for [{{ site.data.variables.product.prodname_desktop }}](https://desktop.github.com/). For more information, see "[Installing {{ site.data.variables.product.prodname_desktop }}](/desktop/installing-and-configuring-github-desktop/installing-github-desktop)."
|
|
|
|
After you have installed {{ site.data.variables.product.prodname_desktop }}, you can authenticate the application with your account on {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}. Authenticating allows you to connect to remote repositories on {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}.
|
|
|
|
{% mac %}
|
|
|
|
1. Before you can authenticate to {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}, you will need an account. For more information about creating an account, see "[Signing up for a new {{ site.data.variables.product.prodname_dotcom }} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)" or contact your {{ site.data.variables.product.prodname_enterprise }} site administrator.
|
|
|
|
2. In the {{ site.data.variables.product.prodname_desktop }} drop-down menu, click **Preferences**. In the preferences window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[Authenticating to {{ site.data.variables.product.prodname_dotcom }}](/desktop/getting-started-with-github-desktop/authenticating-to-github)."
|
|

|
|
|
|
{% endmac %}
|
|
|
|
{% windows %}
|
|
|
|
1. Before you can authenticate to {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}, you will need an account. For more information about creating an account, see "[Signing up for a new {{ site.data.variables.product.prodname_dotcom }} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)" or contact your {{ site.data.variables.product.prodname_enterprise }} site administrator.
|
|
|
|
2. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[Authenticating to {{ site.data.variables.product.prodname_dotcom }}](/desktop/getting-started-with-github-desktop/authenticating-to-github)."
|
|

|
|
|
|
{% endwindows %}
|
|
|
|
### Part 2: Configuring and customizing {{ site.data.variables.product.prodname_desktop }}
|
|
After you install {{ site.data.variables.product.prodname_desktop }}, you can configure and customize the app to best suit your needs.
|
|
|
|
{% mac %}
|
|
|
|
You can connect or remove accounts on {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}, choose a default text editor or shell, edit your Git configuration, change the appearance of {{ site.data.variables.product.prodname_desktop }}, customize system dialogs, and set privacy preferences in the {{ site.data.variables.product.prodname_desktop }} Preferences window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
|
|
|
|

|
|
|
|
{% endmac %}
|
|
|
|
{% windows %}
|
|
|
|
You can connect or remove accounts on {{ site.data.variables.product.prodname_dotcom }} or {{ site.data.variables.product.prodname_enterprise }}, choose a default text editor or shell, edit your Git configuration, change the appearance of {{ site.data.variables.product.prodname_desktop }}, customize system dialogs, and set privacy preferences in the {{ site.data.variables.product.prodname_desktop }} Options window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
|
|
|
|

|
|
|
|
{% endwindows %}
|
|
|
|
### Part 3: Contributing to projects with {{ site.data.variables.product.prodname_desktop }}
|
|
After installing, authenticating, and configuring the app, you are ready to start using {{ site.data.variables.product.prodname_desktop }}. You can create, add, or clone repositories and use {{ site.data.variables.product.prodname_desktop }} to manage contributions to your repositories.
|
|
|
|
#### Creating, adding, and cloning repositories
|
|
You can create a new repository by selecting the File menu and clicking **New repository...**. For more information, see "[Creating your first repository using {{ site.data.variables.product.prodname_desktop }}](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)."
|
|
|
|
You can add a repository from your local computer by selecting the File menu and clicking **Add Local Repository...**. For more information, see "[Adding a repository from your local computer to {{ site.data.variables.product.prodname_desktop }}](/desktop/contributing-and-collaborating-using-github-desktop/adding-a-repository-from-your-local-computer-to-github-desktop)."
|
|
|
|
You can clone a repository from {{ site.data.variables.product.prodname_dotcom }} by selecting the File menu and clicking **Clone Repository...**. For more information, see "[Cloning and Forking Repositories from {{ site.data.variables.product.prodname_desktop }}](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)."
|
|
|
|
{% mac %}
|
|
|
|

|
|
|
|
{% endmac %}
|
|
|
|
{% windows %}
|
|
|
|

|
|
|
|
{% endwindows %}
|
|
|
|
#### Making changes in a branch
|
|
You can use {{ site.data.variables.product.prodname_desktop }} to create a branch of a project. Branches isolate your development work from other branches in the repository, so that you can safely experiment with changes. For more information, see "[Managing branches](/desktop/contributing-and-collaborating-using-github-desktop/managing-branches)."
|
|
|
|

|
|
|
|
After you make changes to a branch, you can review them in {{ site.data.variables.product.prodname_desktop }} and make a commit to keep track of your changes. For more information, see "[Committing and reviewing changes to your project](/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project)."
|
|
|
|

|
|
|
|
If you want to access your changes remotely or share them with other people, you can push your commits to {{ site.data.variables.product.prodname_dotcom }}. For more information, see "[Pushing changes to {{ site.data.variables.product.prodname_dotcom }}](/desktop/contributing-and-collaborating-using-github-desktop/pushing-changes-to-github)."
|
|
|
|
#### Collaborating with {{ site.data.variables.product.prodname_desktop }}
|
|
You can use {{ site.data.variables.product.prodname_desktop }} to create issues or pull requests to collaborate on projects with other people. Issues help you keep track of ideas and discuss possible changes to projects. Pull requests let you share your proposed changes with others, receive feedback, and merge changes into a project. For more information, see "[Creating an issue or pull request](/desktop/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request)."''
|
|
|
|
You can view your own or your collaborator's pull requests in {{ site.data.variables.product.prodname_desktop }}. Viewing a pull request in {{ site.data.variables.product.prodname_desktop }} lets you see any proposed changes and make additional changes by opening the project's files and repositories in your default text editor. For more information, see "[Viewing a pull request in {{ site.data.variables.product.prodname_desktop }}](/desktop/contributing-and-collaborating-using-github-desktop/viewing-a-pull-request-in-github-desktop)."
|
|
|
|
#### Keeping your local repository in sync
|
|
When you make changes to your local repositories or when other people make changes to the remote repositories, you will need to sync your local copy of the project with the remote repository. {{ site.data.variables.product.prodname_desktop }} can keep your local copy of a project in sync with the remote version by pushing and pulling commits. For more information, see "[Syncing your branch](/desktop/contributing-and-collaborating-using-github-desktop/syncing-your-branch)."
|
|
|
|
### Further reading
|
|
- "[Installing and authenticating to {{ site.data.variables.product.prodname_desktop }}](/desktop/getting-started-with-github-desktop/installing-and-authenticating-to-github-desktop)"
|
|
- "[Contributing and collaborating using {{ site.data.variables.product.prodname_desktop }}](/desktop/contributing-and-collaborating-using-github-desktop)"
|