2017-04-10 19:33:57 +00:00
# [GitHub Desktop](https://desktop.github.com)
2016-05-11 16:16:32 +00:00
2017-11-16 11:50:40 +00:00
[](https://travis-ci.org/desktop/desktop)
[](https://circleci.com/gh/desktop/desktop)
[](https://ci.appveyor.com/project/github-windows/desktop/branch/master)
[](https://github.com/desktop/desktop/blob/master/LICENSE)
2016-08-04 16:02:45 +00:00
2017-05-04 11:56:57 +00:00
GitHub Desktop is an open source [Electron ](https://electron.atom.io )-based
GitHub app. It is written in [TypeScript ](http://www.typescriptlang.org ) and
uses [React ](https://facebook.github.io/react/ ).
2016-05-11 16:16:32 +00:00
2017-05-16 07:34:08 +00:00
2017-04-21 06:53:59 +00:00
## Where can I get it?
2017-08-21 05:55:16 +00:00
Download the official installer for your operating system:
2017-04-21 06:53:59 +00:00
2018-02-01 23:08:53 +00:00
- [macOS ](https://central.github.com/deployments/desktop/desktop/latest/darwin )
- [Windows ](https://central.github.com/deployments/desktop/desktop/latest/win32 )
- [Windows machine-wide install ](https://central.github.com/deployments/desktop/desktop/latest/win32?format=msi )
2017-04-10 19:33:57 +00:00
2018-02-01 23:08:53 +00:00
There are several community-supported package managers that can be used to install Github Desktop.
- Windows users can install using [Chocolatey ](https://chocolatey.org/ ) package manager:
`c:\> choco install github-desktop`
- macOS users can install using [Homebrew ](https://brew.sh/ ) package manager:
`$ brew cask install github`
- Arch Linux users can install the latest version from the [AUR ](https://aur.archlinux.org/packages/github-desktop/ ).
2017-08-20 16:14:28 +00:00
2017-04-21 05:09:46 +00:00
You can install this alongside your existing GitHub Desktop for Mac or GitHub
2017-04-21 06:53:59 +00:00
Desktop for Windows application.
**NOTE**: there is no current migration path to import your existing
repositories into the new application - you can drag-and-drop your repositories
from disk onto the application to get started.
2017-04-11 15:17:27 +00:00
2017-11-08 22:15:06 +00:00
### Beta Channel
Want to test out new features and get fixes before everyone else? Install the
beta channel to get access to early builds of Desktop:
2018-02-01 23:08:53 +00:00
- [macOS ](https://central.github.com/deployments/desktop/desktop/latest/darwin?env=beta )
- [Windows ](https://central.github.com/deployments/desktop/desktop/latest/win32?env=beta )
2017-04-26 06:27:22 +00:00
## I have a problem with GitHub Desktop
2018-02-01 23:08:53 +00:00
First, please search the [open issues ](https://github.com/desktop/desktop/issues?q=is%3Aopen )
and [closed issues ](https://github.com/desktop/desktop/issues?q=is%3Aclosed )
to see if your issue hasn't already been reported (it may also be fixed).
2017-04-26 06:27:22 +00:00
2018-02-01 23:08:53 +00:00
If you can't find an issue that matches what you're seeing, open a [new issue ](https://github.com/desktop/desktop/issues/new )
and fill out the template to provide us with enough information to investigate
further.
2017-04-26 06:27:22 +00:00
2017-05-04 11:56:57 +00:00
## How can I contribute to GitHub Desktop?
2017-04-11 15:17:27 +00:00
2017-04-21 06:53:59 +00:00
The [CONTRIBUTING.md ](./CONTRIBUTING.md ) document will help you get setup and
2017-05-04 11:56:57 +00:00
familiar with the source. The [documentation ](docs/ ) folder also contains more
2017-04-21 06:53:59 +00:00
resources relevant to the project.
2018-02-01 23:08:53 +00:00
If you're looking for something to work on, check out the [help wanted ](https://github.com/desktop/desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22 ) label.
2017-05-31 14:23:36 +00:00
2017-04-21 06:53:59 +00:00
## More Resources
See [desktop.github.com ](https://desktop.github.com ) for more product-oriented
information about GitHub Desktop.
2017-04-10 14:41:04 +00:00
## License
**[MIT](LICENSE)**
2017-04-21 05:09:46 +00:00
The MIT license grant is not for GitHub's trademarks, which include the logo
2018-02-01 23:08:53 +00:00
designs. GitHub reserves all trademark and copyright rights in and to all
GitHub trademarks. GitHub's logos include, for instance, the stylized
Invertocat designs that include "logo" in the file title in the following
folder: [logos ](app/static/logos ).
2017-04-10 14:41:04 +00:00
2017-04-21 05:09:46 +00:00
GitHub® and its stylized versions and the Invertocat mark are GitHub's
Trademarks or registered Trademarks. When using GitHub's logos, be sure to
follow the GitHub [logo guidelines ](https://github.com/logos ).
